Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community
Enum TagManager.Taggable

java.lang.Object
  extended by java.lang.Enum<TagManager.Taggable>
      extended by com.jivesoftware.community.TagManager.Taggable
All Implemented Interfaces:
Serializable, Comparable<TagManager.Taggable>
Enclosing interface:
TagManager

public static enum TagManager.Taggable
extends Enum<TagManager.Taggable>

Enumeration of the primary three types of content elements in the system.


Enum Constant Summary
BLOG_POST
           
DOCUMENT
           
SOCIAL_GROUP
           
TASK
           
THREAD
           
USER
           
 
Method Summary
static TagManager.Taggable[] getContentTypesFromValue(long value)
           
 long getID()
           
static TagManager.Taggable getTaggableType(JiveObject object)
           
static long getValueFromTaggables(TagManager.Taggable[] types)
           
static boolean isTaggableEnabled(long value, TagManager.Taggable type)
           
static TagManager.Taggable valueOf(Long value)
           
static TagManager.Taggable valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TagManager.Taggable[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

THREAD

public static final TagManager.Taggable THREAD

DOCUMENT

public static final TagManager.Taggable DOCUMENT

BLOG_POST

public static final TagManager.Taggable BLOG_POST

TASK

public static final TagManager.Taggable TASK

USER

public static final TagManager.Taggable USER

SOCIAL_GROUP

public static final TagManager.Taggable SOCIAL_GROUP
Method Detail

values

public static final TagManager.Taggable[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(TagManager.Taggable c : TagManager.Taggable.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static TagManager.Taggable valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

getID

public long getID()

getContentTypesFromValue

public static TagManager.Taggable[] getContentTypesFromValue(long value)

getValueFromTaggables

public static long getValueFromTaggables(TagManager.Taggable[] types)

isTaggableEnabled

public static boolean isTaggableEnabled(long value,
                                        TagManager.Taggable type)

getTaggableType

public static TagManager.Taggable getTaggableType(JiveObject object)

valueOf

public static TagManager.Taggable valueOf(Long value)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.