io.github.mainstringargs.polygon.websocket.message

Enum PolygonStreamMessageType

java.lang.Object

java.lang.Enum<PolygonStreamMessageType>

io.github.mainstringargs.polygon.websocket.message.PolygonStreamMessageType

All Implemented Interfaces:

APIName, StreamMessageType, java.io.Serializable, java.lang.Comparable<PolygonStreamMessageType>

public enum PolygonStreamMessageType
extends java.lang.Enum<PolygonStreamMessageType>
implements StreamMessageType, APIName

The enum Polygon stream message type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE_PER_MINUTE Aggregate per minute polygon stream message type.
AGGREGATE_PER_SECOND Aggregate per second polygon stream message type.
QUOTE Quote polygon stream message type.
STATUS Status polygon stream message type.
TRADE Trade polygon stream message type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAPIName() Gets the API name.
boolean	isAPISubscribable() Is api subscribable boolean.
static PolygonStreamMessageType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PolygonStreamMessageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATUS

@SerializedName(value="status")
public static final PolygonStreamMessageType STATUS

Status polygon stream message type.

TRADE

@SerializedName(value="T")
public static final PolygonStreamMessageType TRADE

Trade polygon stream message type.

QUOTE

@SerializedName(value="Q")
public static final PolygonStreamMessageType QUOTE

Quote polygon stream message type.

AGGREGATE_PER_SECOND

@SerializedName(value="A")
public static final PolygonStreamMessageType AGGREGATE_PER_SECOND

Aggregate per second polygon stream message type.

AGGREGATE_PER_MINUTE

@SerializedName(value="AM")
public static final PolygonStreamMessageType AGGREGATE_PER_MINUTE

Aggregate per minute polygon stream message type.

Method Detail

values

public static PolygonStreamMessageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PolygonStreamMessageType c : PolygonStreamMessageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PolygonStreamMessageType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAPIName

public java.lang.String getAPIName()

Description copied from interface: APIName

Gets the API name.

Specified by:

getAPIName in interface APIName

Returns:

the API name

isAPISubscribable

public boolean isAPISubscribable()

Is api subscribable boolean.

Returns:

the boolean