Package hudson.model.labels

Class LabelAtom

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.Label

hudson.model.labels.LabelAtom

All Implemented Interfaces:

ModelObject, Saveable, SearchableModelObject, SearchItem, Comparable<Label>, ModelObjectWithChildren, ModelObjectWithContextMenu

public class LabelAtom
extends Label
implements Saveable

Atomic single token label, like "foo" or "bar".

Since:

1.372

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Label

Label.ConverterImpl

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Action>	transientActions

Fields inherited from class hudson.model.Label

loadStatistics, name, nodeProvisioner

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
LabelAtom(String name)

Method Summary

Modifier and Type	Method	Description
<V, P> V	accept(LabelVisitor<V,P> visitor, P param)	Accepts a visitor and call its respective "onXYZ" method based no the actual type of 'this'.
void	doConfigSubmit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Accepts the update to the node configuration.
void	doSubmitDescription(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Accepts the new description.
static String	escape(String name)
static LabelAtom	findNearest(String name)
static LabelAtom	get(String l)	Obtains an atom by its name.
List<Action>	getActions()	Gets actions contributed to this object.
List<LabelAtomPropertyDescriptor>	getApplicablePropertyDescriptors()	Returns all the LabelAtomPropertyDescriptors that can be potentially configured on this label.
String	getDescription()	Returns a human readable text that explains this label.
String	getExpression()	If the label contains 'unsafe' chars, escape them.
DescribableList<LabelAtomProperty,LabelAtomPropertyDescriptor>	getProperties()	Properties associated with this label.
List<LabelAtomProperty>	getPropertiesList()
boolean	isAtom()	Returns true iff this label is an atom.
Set<LabelAtom>	listAtoms()	Lists all the atoms contained in this label.
void	load()
boolean	matches(VariableResolver<Boolean> resolver)	Evaluates whether the label expression is true given the specified value assignment.
static boolean	needsEscape(String name)
LabelOperatorPrecedence	precedence()	Precedence of the top most operator.
void	save()	Persists the state of this object into XML.
void	setDescription(String description)
protected void	updateTransientActions()

Methods inherited from class hudson.model.Label

and, compareTo, contains, doChildrenContextMenu, equals, getApi, getBusyExecutors, getClouds, getDisplayName, getIdleExecutors, getName, getNodes, getSearchUrl, getSortedNodes, getTiedJobCount, getTiedJobs, getTotalConfiguredExecutors, getTotalExecutors, getUrl, hashCode, iff, implies, isAssignable, isEmpty, isOffline, isSelfLabel, matches, matches, not, or, paren, parse, parseExpression, toString

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.model.ModelObjectWithChildren

doChildrenContextMenu

Field Details

transientActions

@CopyOnWrite
protected transient volatile List<Action> transientActions

Constructor Details

LabelAtom

public LabelAtom(@NonNull
 String name)

Method Details

getExpression

public String getExpression()

If the label contains 'unsafe' chars, escape them.

Specified by:

getExpression in class Label

isAtom

public boolean isAtom()

Description copied from class: Label

Returns true iff this label is an atom.

Overrides:

isAtom in class Label

getActions

@NonNull
public List<Action> getActions()

Gets actions contributed to this object.

A new Action can be added by Actionable.addAction(hudson.model.Action).

If you are reading the list, rather than modifying it, use Actionable.getAllActions() instead. This method by default returns only persistent actions (though some subclasses override it to return an extended unmodifiable list).

Note that this method returns a read-only view of Actions. LabelAtomPropertys who want to add a project action should do so by implementing LabelAtomProperty.getActions(LabelAtom).

Overrides:

getActions in class Actionable

Returns:

a possibly empty list

updateTransientActions

protected void updateTransientActions()

getDescription

public String getDescription()

Description copied from class: Label

Returns a human readable text that explains this label.

Overrides:

getDescription in class Label

Since:

1.580

setDescription

public void setDescription(String description)
                    throws IOException

Throws:

IOException

getProperties

public DescribableList<LabelAtomProperty,LabelAtomPropertyDescriptor> getProperties()

Properties associated with this label.

getPropertiesList

@Exported
public List<LabelAtomProperty> getPropertiesList()

matches

public boolean matches(VariableResolver<Boolean> resolver)

Description copied from class: Label

Evaluates whether the label expression is true given the specified value assignment. IOW, returns true if the assignment provided by the resolver matches this label expression.

Specified by:

matches in class Label

accept

public <V,
P> V accept(LabelVisitor<V,P> visitor,
 P param)

Description copied from class: Label

Accepts a visitor and call its respective "onXYZ" method based no the actual type of 'this'.

Specified by:

accept in class Label

listAtoms

public Set<LabelAtom> listAtoms()

Description copied from class: Label

Lists all the atoms contained in this label.

Overrides:

listAtoms in class Label

precedence

public LabelOperatorPrecedence precedence()

Description copied from class: Label

Precedence of the top most operator.

Specified by:

precedence in class Label

save

public void save()
          throws IOException

Description copied from interface: Saveable

Persists the state of this object into XML.

For making a bulk change efficiently, see BulkChange.

To support listeners monitoring changes to this object, call SaveableListener.fireOnChange(hudson.model.Saveable, hudson.XmlFile)

Specified by:

save in interface Saveable

Throws:

IOException - if the persistence failed.

load

public void load()

getApplicablePropertyDescriptors

public List<LabelAtomPropertyDescriptor> getApplicablePropertyDescriptors()

Returns all the LabelAtomPropertyDescriptors that can be potentially configured on this label.

doConfigSubmit

@POST
public void doConfigSubmit(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                    throws IOException,
jakarta.servlet.ServletException,
Descriptor.FormException

Accepts the update to the node configuration.

Throws:

IOException

jakarta.servlet.ServletException

Descriptor.FormException

doSubmitDescription

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public void doSubmitDescription(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                         throws IOException,
jakarta.servlet.ServletException

Accepts the new description.

Throws:

IOException

jakarta.servlet.ServletException

get

@Nullable
public static LabelAtom get(@CheckForNull
 String l)

Obtains an atom by its name.

See Also:

• Jenkins.getLabelAtom(java.lang.String)

findNearest

public static LabelAtom findNearest(String name)

needsEscape

public static boolean needsEscape(String name)

escape

public static String escape(String name)