Apama API Reference for .NET  10.15.2.4
Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT > Class Template Reference

Represents the Apama optional type, for which the contained types are specified as either PrimitiveFieldType<T> or ReferenceFieldType<T> objects. More...

Inherits Apama.Event.Parser.FieldType< T >.

Public Member Functions

override OptionalT DefaultValue ()
 Get the default value for Optional field type. More...
 
override OptionalT Parse (string value)
 Convert a value of this type from the format used in Apama event strings, into an object of type T or Nullable<T> depending on the containedType parameter when creating this optional field type. More...
 
override string ToString ()
 The string representation of this object More...
 
- Public Member Functions inherited from Apama.Event.Parser.FieldType< T >
virtual string Format (Object value)
 Format the given value in MonitorScript representation. More...
 
abstract object GetDefaultValue ()
 Get the default value for this field type. More...
 
Field< T > NewField (string name)
 Creates a new Field object with the specified name, using this field type. More...
 
abstract T Parse (String value)
 Parse a token according to syntax rules of this type. More...
 
abstract object ParseObject (String value)
 Parse a value from this type's Apama event string representation into the .NET object representation of the value. More...
 
override string ToString ()
 For Internal use only More...
 

Properties

FieldType< BaseT > ContainedType [get]
 Get the type of its containedType field. More...
 
override string? Name [get]
 Return the name of this type. More...
 
- Properties inherited from Apama.Event.Parser.FieldType< T >
virtual string Name [get]
 Return the name of this type. More...
 
Type TypeClass [get]
 Return the .NET type used to express values of this Apama field type. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Apama.Event.Parser.FieldType< T >
 FieldType (string typeName, Type clazz)
 Create a new FieldType. More...
 

Detailed Description

Represents the Apama optional type, for which the contained types are specified as either PrimitiveFieldType<T> or ReferenceFieldType<T> objects.

This class should not be instantiated explicitly, but should be referenced using FieldTypes.Optional<T>(PrimitiveFieldType<T>) or FieldTypes.Optional<T>(ReferenceFieldType<T>) depending on the containedType parameter.

Member Function Documentation

◆ DefaultValue()

override OptionalT Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT >.DefaultValue ( )
virtual

Get the default value for Optional field type.

Returns
null as default value for optional field type

Implements Apama.Event.Parser.FieldType< T >.

◆ Parse()

override OptionalT Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT >.Parse ( string  value)

Convert a value of this type from the format used in Apama event strings, into an object of type T or Nullable<T> depending on the containedType parameter when creating this optional field type.

Parameters
valueThe value to parse
Returns
An instance of Field type
Exceptions
ParserRuntimeExceptionIf some problem occurs

◆ ToString()

override string Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT >.ToString ( )

The string representation of this object

Property Documentation

◆ ContainedType

FieldType<BaseT> Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT >.ContainedType
get

Get the type of its containedType field.

Returns
The type of containedType

◆ Name

override string? Apama.Event.Parser.OptionalFieldType< OptionalT, BaseT >.Name
get

Return the name of this type.

Returns
The type name
Submit a bug or feature
Copyright (c) 2013-2023 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.