Apama API Reference for .NET  10.7.2.0
Apama.Event.Parser.SequenceFieldType< E > Class Template Reference

Generic class that represents the Apama sequence<type> type, for which values are specified as System.Collections.Generic.IList<E> objects. More...

Inherits ReferenceFieldType< IList< E >>, and Apama.Event.Parser.FieldType< T >.

Public Member Functions

override IList< E > DefaultValue ()
 Get the default value for Sequence field type. More...
 
override string Format (Object value)
 Format the given value in MonitorScript representation. More...
 
IList Parse (string value)
 Parse a token according to syntax rules of this type. More...
 
override IList< E > Parse (string value)
 Parse a token according to syntax rules of this type. More...
 
 SequenceFieldType (FieldType elementType)
 Construct a new sequence type whose members are all of a given type. More...
 
override string ToString ()
 The string representation of this object More...
 
override string ToString ()
 The string representation of this object More...
 
- Public Member Functions inherited from Apama.Event.Parser.FieldType< T >
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 ElementType [get]
 Get the type of the elements. More...
 
override string Name [get]
 Return the name of this type. 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

Generic class that represents the Apama sequence<type> type, for which values are specified as System.Collections.Generic.IList<E> objects.

Non-generic class that represents the Apama sequence<type> type, for which values are specified as System.Collections.IList objects.

See also
FieldTypes.Sequence<T>(FieldType<T>)

Use this factory method to create a new sequence field type.

See also
SequenceFieldType<T>

The generic sequence field type is recommended instead of this class for new applications.

Constructor & Destructor Documentation

◆ SequenceFieldType()

Construct a new sequence type whose members are all of a given type.

Parameters
elementTypeType of elements this sequence contains

Member Function Documentation

◆ DefaultValue()

override IList<E> Apama.Event.Parser.SequenceFieldType< E >.DefaultValue ( )
virtual

Get the default value for Sequence field type.

Returns
An empty list

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

◆ Format()

override string Apama.Event.Parser.SequenceFieldType< E >.Format ( Object  value)
virtual

Format the given value in MonitorScript representation.

Parameters
valueThe value to format
Returns
The formatted value

Reimplemented from Apama.Event.Parser.FieldType< T >.

◆ Parse() [1/2]

IList Apama.Event.Parser.SequenceFieldType< E >.Parse ( string  value)

Parse a token according to syntax rules of this type.

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

◆ Parse() [2/2]

override IList<E> Apama.Event.Parser.SequenceFieldType< E >.Parse ( string  value)

Parse a token according to syntax rules of this type.

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

◆ ToString() [1/2]

override string Apama.Event.Parser.SequenceFieldType< E >.ToString ( )

The string representation of this object

◆ ToString() [2/2]

override string Apama.Event.Parser.SequenceFieldType< E >.ToString ( )

The string representation of this object

Property Documentation

◆ ElementType

Get the type of the elements.

Returns
The type of sub-elements

◆ Name [1/2]

override string Apama.Event.Parser.SequenceFieldType< E >.Name
get

Return the name of this type.

Returns
The type name

◆ Name [2/2]

override string? Apama.Event.Parser.SequenceFieldType< E >.Name
get

Return the name of this type.

Returns
The type name
Submit a bug or feature
Copyright (c) 2013-2021 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.