Package com.atlassian.bamboo.variable

Class VariableUsage

java.lang.Object

com.atlassian.bamboo.variable.VariableUsage

@Immutable
public class VariableUsage
extends Object

Object representing an analyzed usage of a variable anywhere in Bamboo. Variable usages have the following format: ${<namespace>.<name>}. For example, for a variable usage ${bamboo.maven.arguments}, an instance of VariableUsage would have namespace "bamboo" and name "maven.arguments".

Constructor Summary

Constructors

Constructor	Description
VariableUsage(@NotNull String namespace, @NotNull String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
@NotNull String	getName()
@NotNull String	getNamespace()
int	hashCode()
String	toString()
@NotNull String	toUsageString()	Returns this object's representation as a usage string, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableUsage

public VariableUsage(@NotNull
                     @NotNull String namespace,
                     @NotNull
                     @NotNull String name)

Method Detail

getNamespace

@NotNull
public @NotNull String getNamespace()

getName

@NotNull
public @NotNull String getName()

toUsageString

@NotNull
public @NotNull String toUsageString()

Returns this object's representation as a usage string, e.g. for namespace "bamboo" and name "mavenArgs" the usage string would be "${bamboo.mavenArgs}".

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object