Clearspace API (1.7.0) Core Javadocs

com.jivesoftware.community
Class DocumentFieldValue

java.lang.Object
  extended by com.jivesoftware.community.DocumentFieldValue
All Implemented Interfaces:
com.jivesoftware.community.cache.Cacheable, com.tangosol.io.ExternalizableLite, java.io.Serializable

public class DocumentFieldValue
extends java.lang.Object
implements com.jivesoftware.community.cache.Cacheable, com.tangosol.io.ExternalizableLite

Bean holder for document field values. This class is used to set and retrieve document field values. The choice of whether to use the setOptionIDs(com.jivesoftware.util.LongList) or setStringValue(String) is determined by the data type of the document field. For example, to set the chosen selection list value for a field with a data type of DocumentFieldType.DataType.LIST_SINGLE one would pass in a LongList with a single optionID into the setOptionIDs(com.jivesoftware.util.LongList) and not set any string value.

See Also:
Serialized Form

Constructor Summary
DocumentFieldValue(long fieldID)
           
 
Method Summary
 boolean equals(java.lang.Object o)
           
 int getCachedSize()
           
 long getFieldID()
           
 com.jivesoftware.util.LongList getOptionIDs()
           
 java.lang.String getStringValue()
           
 int hashCode()
           
 void readExternal(java.io.DataInput in)
           
 void setOptionIDs(com.jivesoftware.util.LongList optionIDs)
           
 void setStringValue(java.lang.String value)
           
 void writeExternal(java.io.DataOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentFieldValue

public DocumentFieldValue(long fieldID)
Method Detail

getFieldID

public long getFieldID()

getOptionIDs

public com.jivesoftware.util.LongList getOptionIDs()

setOptionIDs

public void setOptionIDs(com.jivesoftware.util.LongList optionIDs)

getStringValue

public java.lang.String getStringValue()

setStringValue

public void setStringValue(java.lang.String value)

getCachedSize

public int getCachedSize()
Specified by:
getCachedSize in interface com.jivesoftware.community.cache.Cacheable

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException
Specified by:
readExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

Clearspace Project Page

Copyright © 1999-2007 Jive Software.