Package com.myscript.iink

Enum PackageOpenOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PackageOpenOption>
    public enum PackageOpenOption
extends java.lang.Enum<PackageOpenOption>
    Describes the different options given when opening a package.
    Since:
    1.2

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CREATE
      Create a new package if it does not exist.
      CREATE_NEW
      Create a new package, failing if it already exists.
      EXISTING
      Open an existing package.
      TRUNCATE_EXISTING
      If the package already exists then its content is discarded.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PackageOpenOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PackageOpenOption[] 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

      • CREATE

        public static final PackageOpenOption CREATE
        Create a new package if it does not exist.

      • CREATE_NEW

        public static final PackageOpenOption CREATE_NEW
        Create a new package, failing if it already exists.

      • TRUNCATE_EXISTING

        public static final PackageOpenOption TRUNCATE_EXISTING
        If the package already exists then its content is discarded.

    • Method Detail

      • values

        public static PackageOpenOption[] 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 (PackageOpenOption c : PackageOpenOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PackageOpenOption 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