From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- doc/jcgp/backend/parameters/BooleanParameter.html | 394 ++++++++++++++++++++++ 1 file changed, 394 insertions(+) create mode 100644 doc/jcgp/backend/parameters/BooleanParameter.html (limited to 'doc/jcgp/backend/parameters/BooleanParameter.html') diff --git a/doc/jcgp/backend/parameters/BooleanParameter.html b/doc/jcgp/backend/parameters/BooleanParameter.html new file mode 100644 index 0000000..06792b1 --- /dev/null +++ b/doc/jcgp/backend/parameters/BooleanParameter.html @@ -0,0 +1,394 @@ + + + + + +BooleanParameter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parameters
+

Class BooleanParameter

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    BooleanMonitor
    +
    +
    +
    +
    public class BooleanParameter
+extends Parameter<java.lang.Boolean>
    +
    Parameter subclass for the boolean type. Most of the + functionality is already implemented in Parameter, + leaving only construction and type definition to the + subclasses. +

    + This class contains three constructors, two of which are public. + One assumes the parameter is not critical and only takes a name + and initial value, while the other allows the critical flag + to be set as well. The third constructor is protected and allows + the monitor flag to be set as well, allowing subclasses of this class + to be used as monitors. See BooleanMonitor for an example + of this usage. +

    + The validate method is overridden here and left blank since not all + parameters actually require validation, but where validation is + required this method can be anonymously overridden on an instance-to-instance + basis.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      BooleanParameter(boolean value, + java.lang.String name) +
      Creates a new instance of this class, assuming the parameter + is not critical.
      +
      BooleanParameter(boolean value, + java.lang.String name, + boolean critical) +
      Creates a new instance of this class.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Booleanget() 
      voidvalidate(java.lang.Boolean newValue) +
      This is a callback method which gets called whenever changes + to parameters (not only its own instance) are made.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BooleanParameter

        +
        public BooleanParameter(boolean value,
+                        java.lang.String name)
        +
        Creates a new instance of this class, assuming the parameter + is not critical.
        +
        +
        Parameters:
        +
        value - the initial value for this parameter.
        +
        name - the name of this parameter, for GUI display.
        +
        +
        • +
      + + + +
        +
      • +

        BooleanParameter

        +
        public BooleanParameter(boolean value,
+                        java.lang.String name,
+                        boolean critical)
        +
        Creates a new instance of this class.
        +
        +
        Parameters:
        +
        value - the initial value for this parameter.
        +
        name - the name of this parameter, for GUI display.
        +
        critical - true if the parameter is critical.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public java.lang.Boolean get()
        +
        +
        Overrides:
        +
        get in class Parameter<java.lang.Boolean>
        +
        Returns:
        +
        the parameter's current value.
        +
        +
        • +
      + + + +
        +
      • +

        validate

        +
        public void validate(java.lang.Boolean newValue)
        +
        Description copied from class: Parameter
        +
        This is a callback method which gets called whenever changes + to parameters (not only its own instance) are made. This method + is intended to set the status field according to the + new value, so that the user can be informed if any parameters + are currently set to invalid values.
        +
        +
        Specified by:
        +
        validate in class Parameter<java.lang.Boolean>
        +
        Parameters:
        +
        newValue - the new value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + -- cgit v1.2.3