com.atlassian.bamboo.plan
Class AbstractPlanParticle

java.lang.Object
  com.atlassian.bamboo.plan.AbstractPlanParticle

All Implemented Interfaces:

PlanParticle, java.lang.Comparable<PlanParticle>

Direct Known Subclasses:

DefaultPlanParticle, Maven2ArtifactProperties

public abstract class AbstractPlanParticle
extends java.lang.Object
implements PlanParticle, java.lang.Comparable<PlanParticle>

Constructor Summary

protected

AbstractPlanParticle(java.lang.String namespace, java.lang.String key)

Method Summary

int	compareTo(PlanParticle rhs)
boolean	equals(java.lang.Object o)
java.lang.String	getKey() Return PlanParticle key.
java.lang.String	getNamespace() Return PlanParticle namespace.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlanParticle

protected AbstractPlanParticle(java.lang.String namespace,
                               java.lang.String key)

Method Detail

getKey

@NotNull
public java.lang.String getKey()

Description copied from interface: PlanParticle

Return PlanParticle key. PlanParticle's key shall distinguish it from other particles in the same namespace. An example could be concatenation of maven's groupId:artifactId:version

Specified by:

getKey in interface PlanParticle

Returns:

PlanParticle's namespace name

getNamespace

@NotNull
public java.lang.String getNamespace()

Description copied from interface: PlanParticle

Return PlanParticle namespace. Namespace is a string that shall distinguish particles of given type from other particle types. An example could be "com.atlassian.bamboo.plugins.maven2"

Specified by:

getNamespace in interface PlanParticle

Returns:

PlanParticle's namespace name

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public final int compareTo(PlanParticle rhs)

Specified by:

compareTo in interface java.lang.Comparable<PlanParticle>