com.clxcommunications.xms.api

Class GroupId

java.lang.Object

com.clxcommunications.xms.api.GroupId

All Implemented Interfaces:

Comparable<GroupId>

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

Representation of a group 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
GroupId()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupId

public GroupId()

Method Detail

of

@Nonnull
public static GroupId of(String id)

Builds an immutable GroupId having the given literal representation.

Parameters:

id - the group id

Returns:

a non-null group ID

id

protected abstract String id()

The literal string representation of this group identifier.

Returns:

a non-null identifier

compareTo

public int compareTo(GroupId o)

Specified by:

compareTo in interface Comparable<GroupId>

toString

public String toString()

The string representation of this group identifier.

Overrides:

toString in class Object

Returns:

a non-null string