com.buildforge.services.common.dbo
Class SemaphoreDBO
java.lang.Object
com.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.SemaphoreDBO
public class SemaphoreDBO
- extends DBObject
Database information representing a semaphore definition. Semaphores
are not normally manipulated directly for any purpose except listing
and deleting them. Use the .semget
and .semput
commands to acquire and release semaphores, respectively.
Field Summary |
static java.lang.String |
TYPE_KEY
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
TYPE_KEY
public static final java.lang.String TYPE_KEY
- See Also:
- Constant Field Values
SemaphoreDBO
public SemaphoreDBO()
getTypeKey
public java.lang.String getTypeKey()
- Description copied from class:
DBObject
- Retrieve the key that should be used to look up the display name
for a data type.
- Specified by:
getTypeKey
in class DBObject
- Returns:
- the type key for this object's class
isLive
public boolean isLive()
- Description copied from class:
DBObject
- Checks whether or not the object is live. Note that this is not
valid for object types that do not have a unique identifier. Those
for which no reasonable implementation exists should always return
false.
- Specified by:
isLive
in class DBObject
- Returns:
- true iff liveness is a valid concept for this object,
and the object is live; otherwise, false is returned.
getActive
public boolean getActive()
getBuildId
public int getBuildId()
getName
public java.lang.String getName()
getRequestor
public java.lang.String getRequestor()
getTimestamp
public int getTimestamp()
getUserId
public java.lang.String getUserId()
getLiveName
public java.lang.String getLiveName()
setActive
public void setActive(boolean active)
setBuildId
public void setBuildId(int buildId)
setName
public void setName(java.lang.String name)
setRequestor
public void setRequestor(java.lang.String requestor)
setTimestamp
public void setTimestamp(int timestamp)
setUserId
public void setUserId(java.lang.String uid)
setLiveName
public void setLiveName(java.lang.String liveName)
sanityCheckName
public static void sanityCheckName(java.lang.String name)
throws APIException
- Throws:
APIException
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
fromArray
public SemaphoreDBO fromArray(java.lang.Object[] data)
throws APIException
- Description copied from class:
DBObject
- Deserialize the database object's settings from a request array.
This method is used to reconstruct a database object from the
array that was created by
DBObject.toArray()
.
- Specified by:
fromArray
in class DBObject
- Parameters:
data
- the object list that renders this object
- Returns:
- this object, for convenience
- Throws:
APIException
- if there is something wrong with the
serialized data that interferes with the reconstruction of
the object. The most obvious reason for this would be if
the serialized array contains the wrong number of fields
or otherwise does not match the serialized form for this
type of database object.
toArray
public java.lang.Object[] toArray()
- Description copied from class:
DBObject
- Serializes this database object as an array of objects. As
specified in the description for
Protocol
, all supported
protocols transfer database objects in this form.
- Specified by:
toArray
in class DBObject