com.streambase.sb.operator.parameter

## Class JavaEnumPropertyDescriptor<T extends Enum<T>>

- java.lang.Object
- - java.beans.FeatureDescriptor
  - - java.beans.PropertyDescriptor
    - - com.streambase.sb.operator.parameter.SBPropertyDescriptor
      - - com.streambase.sb.operator.parameter.EnumPropertyDescriptor
        - - com.streambase.sb.operator.parameter.JavaEnumPropertyDescriptor<T>

- Type Parameters:
    `T` - Enumeration type

      public class JavaEnumPropertyDescriptor<T extends Enum<T>>
      extends EnumPropertyDescriptor

  PropertyDescriptor for properties based on a Java Enum.
  Since:
    6.4
  See Also:
    `SBPropertyDescriptor`

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

      `SBPropertyDescriptor.SingleValueSetter`

  - ### Field Summary

    - ### Fields inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

      `_expressionInputPort, NOT_AN_EXPRESSION`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `JavaEnumPropertyDescriptor(String propertyName, Class<?> beanClass, Class<T> enumClass)` Construct an enumerated property descriptor.
    `JavaEnumPropertyDescriptor(String propertyName, Class<?> beanClass, Class<T> enumClass, T... validOptions)` Construct an enumerated property descriptor.
    `JavaEnumPropertyDescriptor(String propertyName, Class<?> beanClass, EnumSet<T> valueSet)` Construct an enumerated property descriptor.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Class<T>` | `getEnumClass()` Get enumeration class
    `protected SBPropertyDescriptor.Setter` | `getSetter()`

    - ### Methods inherited from class com.streambase.sb.operator.parameter.EnumPropertyDescriptor

      `getValues, isValidValue, setValues`

    - ### Methods inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

      `deprecated, description, displayName, getExpressionInputPort, getMaskDisplay, getMultiLine, getUIHints, isDeprecated, isExpression, isRequired, mask, multiline, optional, setDeprecated, setMaskStringDisplay, setMultiLine, setRequired, setUIHints`

    - ### Methods inherited from class java.beans.PropertyDescriptor

      `createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod`

    - ### Methods inherited from class java.beans.FeatureDescriptor

      `attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### JavaEnumPropertyDescriptor

          public JavaEnumPropertyDescriptor(String propertyName,
                                            Class<?> beanClass,
                                            Class<T> enumClass)
                                     throws IntrospectionException

      Construct an enumerated property descriptor.
      Parameters:
        `propertyName` - the name of the property
        `beanClass` - the operator class containing the property
        `enumClass` - the class for the enum
      Throws:
        `IntrospectionException` - if introspection fails

    - #### JavaEnumPropertyDescriptor

          @SafeVarargs
          public JavaEnumPropertyDescriptor(String propertyName,
                                                          Class<?> beanClass,
                                                          Class<T> enumClass,
                                                          T... validOptions)
                                                   throws IntrospectionException

      Construct an enumerated property descriptor.
      Parameters:
        `propertyName` - the name of the property
        `beanClass` - the operator class containing the property
        `enumClass` - the class for the enum
        `validOptions` - the valid options for the drop-down. If absent, all.
      Throws:
        `IntrospectionException` - if introspection fails

    - #### JavaEnumPropertyDescriptor

          public JavaEnumPropertyDescriptor(String propertyName,
                                            Class<?> beanClass,
                                            EnumSet<T> valueSet)
                                     throws IntrospectionException,
                                            IllegalArgumentException

      Construct an enumerated property descriptor.
      Parameters:
        `propertyName` - the name of the property
        `beanClass` - the operator class containing the property
        `valueSet` - A subset of an enumeration to use as values. The set must not be empty.
      Throws:
        `IntrospectionException` - if introspection fails
        `IllegalArgumentException` - if valueSet is empty
      Since:
        6.4

  - ### Method Detail

    - #### getEnumClass

          public Class<T> getEnumClass()

      Get enumeration class
      Returns:
        Enumeration class

    - #### getSetter

          protected SBPropertyDescriptor.Setter getSetter()
                                                   throws TypecheckException

      Overrides:
        `getSetter` in class `EnumPropertyDescriptor`
      Returns:
        the setter for this propert descriptor
      Throws:
        `TypecheckException` - on type check exception

Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.