co.cask.cdap.proto.id

Class EntityId

java.lang.Object

co.cask.cdap.proto.id.EntityId

All Implemented Interfaces:

IdCompatible

Direct Known Subclasses:

ApplicationId, ArtifactId, DatasetId, DatasetModuleId, DatasetTypeId, FlowletId, FlowletQueueId, InstanceId, NamespaceId, NotificationFeedId, ProgramId, ProgramRunId, QueryId, ScheduleId, SecureKeyId, StreamId, StreamViewId, SystemServiceId

public abstract class EntityId
extends Object
implements IdCompatible

Uniquely identifies a particular instance of an element.

When adding a new type of EntityId, the following must be done:

1. Implement interfaces
   1. NamespacedId if the new ID belongs to a namespace
   2. ParentedId if the new ID has a parent ID
2. Add methods
   1. equals() and hashCode(), using the implementations in EntityId
   2. fromString(String string), delegating to fromString(String, Class)
3. Create a corresponding child class of the old Id (once Id is removed, this is no longer needed)
4. Add a new entry to EntityType, associating the EntityType with both the new EntityId and old Id

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityId(EntityType entity)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static <T extends EntityId> T	fromString(String string)
protected static <T extends EntityId> T	fromString(String string, Class<T> idClass)
static <T extends Id> T	fromStringOld(String string, Class<T> oldIdClass)
EntityType	getEntity()
Iterable<EntityId>	getHierarchy()
int	hashCode()
static boolean	isValidDatasetId(String datasetId)
static boolean	isValidId(String name)
protected static String	next(Iterator<String> iterator, String fieldName)
protected static String	nextAndEnd(Iterator<String> iterator, String fieldName)
protected static String	remaining(Iterator<String> iterator, String fieldName)
protected abstract Iterable<String>	toIdParts()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.cask.cdap.proto.id.IdCompatible

toId

Constructor Detail

EntityId

protected EntityId(EntityType entity)

Method Detail

isValidId

public static boolean isValidId(String name)

isValidDatasetId

public static boolean isValidDatasetId(String datasetId)

toIdParts

protected abstract Iterable<String> toIdParts()

getEntity

public final EntityType getEntity()

fromStringOld

public static <T extends Id> T fromStringOld(String string,
                             Class<T> oldIdClass)

fromString

public static <T extends EntityId> T fromString(String string)

fromString

protected static <T extends EntityId> T fromString(String string,
                                @Nullable
                                Class<T> idClass)

toString

public final String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

next

protected static String next(Iterator<String> iterator,
          String fieldName)

nextAndEnd

protected static String nextAndEnd(Iterator<String> iterator,
                String fieldName)

remaining

protected static String remaining(Iterator<String> iterator,
               @Nullable
               String fieldName)

getHierarchy

public Iterable<EntityId> getHierarchy()