IpcToken (SMILA 1.2 API documentation)

java.lang.Object
- java.lang.Enum<IpcToken>
- - org.eclipse.smila.ipc.IpcToken

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IpcToken>
```
public enum IpcToken
extends java.lang.Enum<IpcToken>
```
IPC Tokens. Tokens of underlying implementations must be mapped to these tokens.

Author:

aweber

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ATTACHMENTS_END` end of list of attachments.
`ATTACHMENTS_START` start of list of attachments.
`BINARY` single binary object.
`MAPPING_END` end of a mapping.
`MAPPING_START` start of a mapping.
`OBJECT_END` end of an object (= document) in stream.
`OBJECT_START` start of an object (= document) in stream.
`SCALAR_BOOL` current value is a boolean.
`SCALAR_DOUBLE` current value is a double.
`SCALAR_INT` current value is a integer.
`SCALAR_STRING` current value is a string.
`SEQUENCE_END` end of a sequence.
`SEQUENCE_START` start of a sequence.
`UNDEFINED` hm. what's this.

Method Summary

Methods
Modifier and Type	Method and Description
`static IpcToken`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static IpcToken[]`	`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
  - OBJECT_START
```
public static final IpcToken OBJECT_START
```
    start of an object (= document) in stream.
  - OBJECT_END
```
public static final IpcToken OBJECT_END
```
    end of an object (= document) in stream.
  - MAPPING_START
```
public static final IpcToken MAPPING_START
```
    start of a mapping.
  - MAPPING_END
```
public static final IpcToken MAPPING_END
```
    end of a mapping.
  - SEQUENCE_START
```
public static final IpcToken SEQUENCE_START
```
    start of a sequence.
  - SEQUENCE_END
```
public static final IpcToken SEQUENCE_END
```
    end of a sequence.
  - SCALAR_INT
```
public static final IpcToken SCALAR_INT
```
    current value is a integer.
  - SCALAR_STRING
```
public static final IpcToken SCALAR_STRING
```
    current value is a string.
  - SCALAR_DOUBLE
```
public static final IpcToken SCALAR_DOUBLE
```
    current value is a double.
  - SCALAR_BOOL
```
public static final IpcToken SCALAR_BOOL
```
    current value is a boolean.
  - ATTACHMENTS_START
```
public static final IpcToken ATTACHMENTS_START
```
    start of list of attachments.
  - ATTACHMENTS_END
```
public static final IpcToken ATTACHMENTS_END
```
    end of list of attachments.
  - BINARY
```
public static final IpcToken BINARY
```
    single binary object.
  - UNDEFINED
```
public static final IpcToken UNDEFINED
```
    hm. what's this.
- Method Detail
  - values
```
public static IpcToken[] 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 (IpcToken c : IpcToken.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IpcToken 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

Enum IpcToken

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OBJECT_START

OBJECT_END

MAPPING_START

MAPPING_END

SEQUENCE_START

SEQUENCE_END

SCALAR_INT

SCALAR_STRING

SCALAR_DOUBLE

SCALAR_BOOL

ATTACHMENTS_START

ATTACHMENTS_END

BINARY

UNDEFINED

Method Detail

values

valueOf