com.google.code.linkedinapi.client.enumeration
Enum FacetField

java.lang.Object
  extended by java.lang.Enum<FacetField>
      extended by com.google.code.linkedinapi.client.enumeration.FacetField
All Implemented Interfaces:
CompositeEnum<FacetField>, FieldEnum, java.io.Serializable, java.lang.Comparable<FacetField>

public enum FacetField
extends java.lang.Enum<FacetField>
implements CompositeEnum<FacetField>

Author:
Nabeel Mukhtar

Enum Constant Summary
BUCKET_CODE
          The machine processable value for the bucket.
BUCKET_COUNT
          The number of results inside the bucket.
BUCKET_NAME
          A human readable name for the facet bucket.
BUCKET_SELECTED
          If this bucket's results are included in your search query.
BUCKETS
          The facet bucket values for the facet.
CODE
          The machine processable value for the facet.
NAME
          A human readable name for the facet.
 
Field Summary
private  java.lang.String fieldName
          Field description
private  FacetField parent
          Field description
private static java.util.Map<java.lang.String,FacetField> stringToEnum
          Field Description.
 
Method Summary
 java.lang.String fieldName()
           
static FacetField fromString(java.lang.String symbol)
           
 FacetField parent()
          Parent.
 java.lang.String toString()
          Method description
static FacetField valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FacetField[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NAME

public static final FacetField NAME
A human readable name for the facet.


CODE

public static final FacetField CODE
The machine processable value for the facet.


BUCKETS

public static final FacetField BUCKETS
The facet bucket values for the facet.


BUCKET_NAME

public static final FacetField BUCKET_NAME
A human readable name for the facet bucket.


BUCKET_CODE

public static final FacetField BUCKET_CODE
The machine processable value for the bucket.


BUCKET_COUNT

public static final FacetField BUCKET_COUNT
The number of results inside the bucket.


BUCKET_SELECTED

public static final FacetField BUCKET_SELECTED
If this bucket's results are included in your search query.

Field Detail

stringToEnum

private static final java.util.Map<java.lang.String,FacetField> stringToEnum
Field Description.


fieldName

private final java.lang.String fieldName
Field description


parent

private final FacetField parent
Field description

Method Detail

values

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

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

valueOf

public static FacetField valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

fieldName

public java.lang.String fieldName()
Specified by:
fieldName in interface FieldEnum
Returns:
the name of the field

toString

public java.lang.String toString()
Method description

Overrides:
toString in class java.lang.Enum<FacetField>
Returns:

fromString

public static FacetField fromString(java.lang.String symbol)
Returns:
Returns ProfileType for string, or null if string is invalid

parent

public FacetField parent()
Description copied from interface: CompositeEnum
Parent.

Specified by:
parent in interface CompositeEnum<FacetField>
Returns:
the parent