com.alarmpoint.integrationagent.apxml

Interface APXMLToken

All Superinterfaces:

java.io.Serializable

public interface APXMLToken
extends java.io.Serializable

The primary content of an APXML message is composed of tokens. Each token has a key, which is a non-empty lowercase string that does not contain spaces. The token value is also a string; however, it can have any content, including being empty. Tokens also have a type, which the AlarmPoint Node uses to convert the string value into a corresponding Java object. An AUTO type means that the AlarmPoint Node will convert the string value to a number if it is of an appropriate type. To force a specific conversion, assign the token the appropriate non-AUTO type.

NOTE:By convention, implementations are thread-safe and immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	APXMLToken.Type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() Gets the token's key (i.e., name).
APXMLToken.Type	getType() Get's the token's type.
java.lang.String	getValue() Get's the token's value.

Method Detail

getKey

java.lang.String getKey()

Gets the token's key (i.e., name).

Returns:

a non-empty String that is in lowercase and does not contain spaces

getValue

java.lang.String getValue()

Get's the token's value.

Returns:

a non-null String

getType

APXMLToken.Type getType()

Get's the token's type.

Returns:

a non-null Type