Package xal.extension.solver.hint

Class Hint

java.lang.Object
xal.extension.solver.hint.Hint
Direct Known Subclasses:
DomainHint, ExcursionHint
public abstract class Hint extends Object
Hint is the abstract class used for implementing hints.
Author:
ky6

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    label
    the Hint's label

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Hint(String aHint)
    Creates a new instance of Hint

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getLabel()
    Get this hint's label.
    abstract String
    getType()
    Get the type identifier of this Hint which will be used to fetch this hint in a table of hints.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • label

      protected String label
      the Hint's label

  • Constructor Details

    • Hint

      protected Hint(String aHint)
      Creates a new instance of Hint

  • Method Details

    • getLabel

      public String getLabel()
      Get this hint's label.
      Returns:
      this hint's label.

    • getType

      public abstract String getType()
      Get the type identifier of this Hint which will be used to fetch this hint in a table of hints. Subclasses should override this method to return a unique string identifying the hint.
      Returns:
      the unique type identifier of this Hint