org.kie.api.runtime.conf

## Enum KeepReferenceOption

- java.lang.Object
- - java.lang.Enum<KeepReferenceOption>
  - - org.kie.api.runtime.conf.KeepReferenceOption

- All Implemented Interfaces:
    Serializable, Comparable<KeepReferenceOption>, Option, KieSessionOption, SingleValueKieSessionOption

      public enum KeepReferenceOption
      extends Enum<KeepReferenceOption>
      implements SingleValueKieSessionOption

  Option to configure if the knowledge base should retain a reference to the knowledge session or not. The default is YES, i.e., the reference is retained.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `NO`
    `YES`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `PROPERTY_NAME` The property name for the keep reference configuration

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getPropertyName()` Returns the property name for this option
    `boolean` | `isKeepReference()`
    `static KeepReferenceOption` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static KeepReferenceOption[]` | `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, toString, valueOf`

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

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### YES

          public static final KeepReferenceOption YES

    - #### NO

          public static final KeepReferenceOption NO

  - ### Field Detail

    - #### PROPERTY_NAME

          public static final String PROPERTY_NAME

      The property name for the keep reference configuration
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### values

          public static KeepReferenceOption[] 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 (KeepReferenceOption c : KeepReferenceOption.values())
              System.out.println(c);

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

    - #### valueOf

          public static KeepReferenceOption 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
        `NullPointerException` - if the argument is null

    - #### getPropertyName

          public String getPropertyName()

      Returns the property name for this option
      Specified by:
        `getPropertyName` in interface `Option`
      Returns:

    - #### isKeepReference

          public boolean isKeepReference()

Copyright © 2001–2015 JBoss by Red Hat. All rights reserved.