|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.CollectorProperty
public final class CollectorProperty
An object representing a collector property within the Build Forge
system. Collectors are assigned to servers, and they gather information
from those servers that can later be used by selectors
when determining which server should be used for running a step. The
pieces of information to gather from the server are specified using
collector properties.
Field Summary | |
---|---|
static java.lang.Class<CollectorProperty> |
CLASS
|
Constructor Summary | |
---|---|
CollectorProperty(APIClientConnection conn,
Collector parent)
Defines a new collector property object. |
Method Summary | |
---|---|
void |
delete()
Removes this collector property from its parent collector. |
java.lang.String |
getCollectorName()
The name of the collector to which this property belongs. |
Collector |
getParent()
Returns a reference to this collector property's parent collector. |
java.lang.String |
getPropertyName()
The name of this collector property. |
java.lang.String |
getPropertyValue()
The value of this collector property. |
java.lang.String |
getRegex()
Returns the regular expression to use for this collector property. |
int |
getSequenceNumber()
Returns the sequence number for this collector property. |
boolean |
getUserDefined()
Whether or not this is a user-defined property, as opposed to a built-in property. |
void |
moveTo(int newIndex)
Moves this property to a new index. |
void |
setPropertyName(java.lang.String propertyName)
Sets the name of this collector property. |
void |
setPropertyValue(java.lang.String propertyValue)
Sets the value of the collector property. |
void |
setRegex(java.lang.String regex)
Sets the regular expression for this collector property. |
void |
setUserDefined(boolean userDefined)
Sets whether or not this CollectorProperty references a built-in property. |
java.lang.String |
toString()
|
CollectorProperty |
update()
Updates this existing collector property to use the updated values in this object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class<CollectorProperty> CLASS
Constructor Detail |
---|
public CollectorProperty(APIClientConnection conn, Collector parent)
.create()
ed.
conn
- the services layer connection that the collector property
should use when submitting requestsparent
- the collector to which this property belongsMethod Detail |
---|
public CollectorProperty update() throws java.io.IOException, ServiceException
Restrictions: Requires Permission.EditCollector
.
java.io.IOException
ServiceException
public void delete() throws java.io.IOException, ServiceException
Restrictions: Requires Permission.EditCollector
if the
parent collector is live.
java.io.IOException
ServiceException
public void moveTo(int newIndex) throws java.io.IOException, ServiceException
Collector.moveCollectorProperty(int, int)
, and the
same behavior and restrictions apply
newIndex
- as for Collector.moveCollectorProperty(int, int)
java.io.IOException
ServiceException
public Collector getParent()
public java.lang.String getCollectorName()
public java.lang.String getPropertyName()
public java.lang.String getPropertyValue()
If the command fails to execute, or if its output does not match the regular expression, or if the regular expression fails to return any match groups, then the property is left unset. If the regular expression is null, then this value is used directly as the value for this collector property.
public java.lang.String getRegex()
getPropertyValue()
entry.
public boolean getUserDefined()
public int getSequenceNumber()
public void setPropertyName(java.lang.String propertyName)
public void setPropertyValue(java.lang.String propertyValue)
getPropertyValue()
for more information.
public void setRegex(java.lang.String regex)
getPropertyValue()
for more information.
public void setUserDefined(boolean userDefined)
Collector.getBuiltIns()
for a list of built-in
property names, or see CollectorPropertyDBO.BuiltIn
. Use
true unless you are certain that you want one of the built-ins.
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |