|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.core.bean.EntityObject com.atlassian.confluence.labels.Label
public class Label
Field Summary | |
---|---|
static org.apache.log4j.Category |
log
|
Constructor Summary | |
---|---|
Label()
|
|
Label(java.lang.String name)
|
|
Label(java.lang.String name,
Namespace namespace)
|
|
Label(java.lang.String name,
Namespace namespace,
java.lang.String owner)
|
|
Label(java.lang.String name,
java.lang.String namespace,
java.lang.String owner)
|
Method Summary | |
---|---|
int |
compareTo(java.lang.Object o)
|
boolean |
equals(java.lang.Object o)
Equals implementation is a value based implementation. |
java.lang.String |
getDisplayTitle()
The title of the addressable object, suitable for display in a list |
java.lang.String |
getName()
Returns the label's name only. |
Namespace |
getNamespace()
|
java.lang.String |
getOwner()
|
java.lang.String |
getRealTitle()
Deprecated. since 2.8 - see Addressable |
java.lang.String |
getType()
|
java.lang.String |
getUrlPath()
Generates the url path for a label. |
java.lang.String |
getUrlPath(java.lang.String spaceKey)
Generates the url path for a label in the context of a given space i.e. |
int |
hashCode()
|
boolean |
isNew()
|
boolean |
isPersistent()
This label is persistent iff the id is not 0. |
boolean |
isRealTitleSafeForUrl()
Returns true if the label's title is safe to pass in the URL. |
boolean |
isTeamLabel()
|
boolean |
isVisibleTo(java.lang.String username)
Determines whether the label should be made visible to a particular user. |
java.lang.String |
toString()
|
java.lang.String |
toStringWithNamespace()
|
java.lang.String |
toStringWithOwnerPrefix()
|
Methods inherited from class com.atlassian.core.bean.EntityObject |
---|
clone, getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.atlassian.confluence.core.Addressable |
---|
getId |
Field Detail |
---|
public static final org.apache.log4j.Category log
Constructor Detail |
---|
public Label()
public Label(java.lang.String name)
public Label(java.lang.String name, Namespace namespace)
public Label(java.lang.String name, java.lang.String namespace, java.lang.String owner)
public Label(java.lang.String name, Namespace namespace, java.lang.String owner)
Method Detail |
---|
public java.lang.String getName()
DisplayableLabel
eg. label name for label my:foo is "foo".
getName
in interface DisplayableLabel
public java.lang.String getOwner()
public Namespace getNamespace()
public java.lang.String getType()
getType
in interface Addressable
public boolean equals(java.lang.Object o)
equals
in class com.atlassian.core.bean.EntityObject
o
-
public int hashCode()
hashCode
in class com.atlassian.core.bean.EntityObject
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public java.lang.String getRealTitle()
Addressable
DisplayableLabel
getRealTitle
in interface Addressable
getRealTitle
in interface DisplayableLabel
public java.lang.String getDisplayTitle()
Addressable
getDisplayTitle
in interface Addressable
public boolean isRealTitleSafeForUrl()
DisplayableLabel
eg. my:foo is safe, perc% is not safe. chicken+cheese is safe in a "combined" label.
isRealTitleSafeForUrl
in interface DisplayableLabel
public java.lang.String getUrlPath()
DisplayableLabel
getUrlPath
in interface Addressable
getUrlPath
in interface DisplayableLabel
public java.lang.String getUrlPath(java.lang.String spaceKey)
DisplayableLabel
DisplayableLabel.getUrlPath()
is called.
getUrlPath
in interface DisplayableLabel
public boolean isNew()
public boolean isPersistent()
public boolean isVisibleTo(java.lang.String username)
username
- the username of the user who wishes to see the label
public java.lang.String toStringWithOwnerPrefix()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringWithNamespace()
public boolean isTeamLabel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |