Package org.ka2ddo.yaac.bootstrap

Class FirstWindow

java.lang.Object
org.ka2ddo.yaac.bootstrap.FirstWindow
All Implemented Interfaces:
Comparable<FirstWindow>
public final class FirstWindow extends Object implements Comparable<FirstWindow>
The values of this pseudo-enumeration specify which first window should be launched when the GUI is started. This is to help accessibility by starting YAAC with a window that is easier for visually impaired users to use, or for other environments where the default map window is not suitable. The name of some instance of this class can be specified as the value to the command-line "-gui:value" option.
Author:
Andrew Pavlin, KA2DDO

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final FirstWindow
    help
    Bring up a display listing the legal values for first windows.
    static final FirstWindow
    map
    Bring up the default map (original behavior of YAAC).
    static final FirstWindow
    stationlist
    Bring up the stations/object list.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    clone()
    Throws CloneNotSupportedException.
    final int
    compareTo(FirstWindow o)
    Compares this enum with the specified object for order.
    final boolean
    equals(Object other)
    Returns true if the specified object is equal to this enum constant.
    String
    getClassTag()
    Get a resource name that will translate to a fully qualified class name for this particular first UI window choice.
    final Class<? extends FirstWindow>
    getDeclaringClass()
    Returns the Class object corresponding to this enum constant's enum type.
    final int
    hashCode()
    Returns a hash code for this enum constant.
    final String
    name()
    Returns the name of this pseudo-enum constant, exactly as declared in its enum declaration.
    final int
    ordinal()
    Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
    static void
    registerNewFirstWindowType(String name, String classTag)
    Add a new type of FirstWindow.
    String
    toString()
    Returns the name of this enum constant, as contained in the declaration.
    static FirstWindow
    valueOf(String name)
    Returns the enum constant of the specified enum type with the specified name.
    static FirstWindow[]
    values()
    Get all the allowable values of the FirstWindow pseudo-enum.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • help

      public static final FirstWindow help
      Bring up a display listing the legal values for first windows.

    • map

      public static final FirstWindow map
      Bring up the default map (original behavior of YAAC).

    • stationlist

      public static final FirstWindow stationlist
      Bring up the stations/object list.

  • Method Details

    • name

      public final String name()
      Returns the name of this pseudo-enum constant, exactly as declared in its enum declaration. Most programmers should use the toString() method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.
      Returns:
      the name of this enum constant

    • ordinal

      public final int ordinal()
      Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures, such as EnumSet and EnumMap.
      Returns:
      the ordinal of this enumeration constant

    • getClassTag

      public String getClassTag()
      Get a resource name that will translate to a fully qualified class name for this particular first UI window choice. There may be an asterisk "*" in the string which will be replaced by the appropriate string for the local graphics platform.
      Returns:
      String resource name

    • toString

      public String toString()
      Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum type should override this method when a more "programmer-friendly" string form exists.
      Overrides:
      toString in class Object
      Returns:
      the name of this enum constant

    • equals

      public final boolean equals(Object other)
      Returns true if the specified object is equal to this enum constant.
      Overrides:
      equals in class Object
      Parameters:
      other - the object to be compared for equality with this object.
      Returns:
      true if the specified object is equal to this enum constant.

    • hashCode

      public final int hashCode()
      Returns a hash code for this enum constant.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code for this enum constant.

    • clone

      protected final Object clone() throws CloneNotSupportedException
      Throws CloneNotSupportedException. This guarantees that enums are never cloned, which is necessary to preserve their "singleton" status.
      Overrides:
      clone in class Object
      Returns:
      (never returns)
      Throws:
      CloneNotSupportedException

    • compareTo

      public final int compareTo(FirstWindow o)
      Compares this enum with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Enum constants are only comparable to other enum constants of the same enum type. The natural order implemented by this method is the order in which the constants are declared.
      Specified by:
      compareTo in interface Comparable<FirstWindow>

    • getDeclaringClass

      public final Class<? extends FirstWindow> getDeclaringClass()
      Returns the Class object corresponding to this enum constant's enum type. Two enum constants e1 and e2 are of the same enum type if and only if e1.getDeclaringClass() == e2.getDeclaringClass(). (The value returned by this method may differ from the one returned by the Object.getClass() method for enum constants with constant-specific class bodies.)
      Returns:
      the Class object corresponding to this enum constant's enum type

    • valueOf

      public static FirstWindow valueOf(String name)
      Returns the enum constant of the specified enum type with the specified name. The name 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 constant to return
      Returns:
      the enum constant of the specified enum type with the specified name
      Throws:
      IllegalArgumentException - if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type
      NullPointerException - if enumType or name is null

    • registerNewFirstWindowType

      public static void registerNewFirstWindowType(String name, String classTag) throws IllegalArgumentException
      Add a new type of FirstWindow. This can be called by plugins to register additional first window choices before the first window is actually opened.
      Parameters:
      name - String name of the new type
      classTag - String name of property listing the corresponding class name
      Throws:
      IllegalArgumentException - if type name already registered

    • values

      public static FirstWindow[] values()
      Get all the allowable values of the FirstWindow pseudo-enum.
      Returns:
      array of FirstWindow values