com.clxcommunications.xms.api

Class BatchId

java.lang.Object

com.clxcommunications.xms.api.BatchId

All Implemented Interfaces:

Comparable<BatchId>

@Value.Immutable
 @ParametersAreNonnullByDefault
public abstract class BatchId
extends Object
implements Comparable<BatchId>

Representation of a batch identifier. These are in the JSON representation simply string literals but they are within the Java API represented in a more type safe way using this class.

To fetch the literal batch identifier use the toString() method.

Constructor Summary

Constructors

Constructor and Description
BatchId()

Method Summary

Modifier and Type	Method and Description
int	compareTo(BatchId o)
protected abstract String	id() The literal string representation of this batch identifier.
static BatchId	of(String id) Builds an immutable BatchId having the given literal representation.
String	toString() The string representation of this batch identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchId

public BatchId()

Method Detail

of

@Nonnull
public static BatchId of(String id)

Builds an immutable BatchId having the given literal representation.

Parameters:

id - the literal batch identifier

Returns:

a batch identifier

id

protected abstract String id()

The literal string representation of this batch identifier.

Returns:

a non-null identifier

compareTo

public int compareTo(BatchId o)

Specified by:

compareTo in interface Comparable<BatchId>

toString

public String toString()

The string representation of this batch identifier.

Overrides:

toString in class Object

Returns:

a non-null string