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/resources/Console.html | 286 ++++++++++++++++++++++++++++++++ 1 file changed, 286 insertions(+) create mode 100644 doc/jcgp/backend/resources/Console.html (limited to 'doc/jcgp/backend/resources/Console.html') diff --git a/doc/jcgp/backend/resources/Console.html b/doc/jcgp/backend/resources/Console.html new file mode 100644 index 0000000..e920f61 --- /dev/null +++ b/doc/jcgp/backend/resources/Console.html @@ -0,0 +1,286 @@ + + + + + +Console + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.resources
+

Interface Console

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    GUIConsole
    +
    +
    +
    +
    public interface Console
    +
    Defines the basic model for a console. +

    + This interface will typically be implemented by a GUI class + and GUI packages such as JavaFX are usually single-threaded. + If the CGP experiment is running on a side thread (which would + be the case so as not to block the entire GUI), updating a GUI + element such as the console from a different thread would lead + to concurrency problems. For this reason, this console is + intended to buffer printed messages and only output them to the + actual GUI control when flush() is called (which is + guaranteed to be done in a thread-safe way by the library).
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidflush() +
      Outputs all buffered messages to the console.
      +
      voidprint(java.lang.String s) +
      Prints a string without line break at the end (unless the string + itself specifies one).
      +
      voidprintln(java.lang.String s) +
      Prints a string and automatically adds a line break at the end.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        println

        +
        void println(java.lang.String s)
        +
        Prints a string and automatically adds a line break at the end.
        +
        +
        Parameters:
        +
        s - the string to print.
        +
        +
      • +
      + + + +
        +
      • +

        print

        +
        void print(java.lang.String s)
        +
        Prints a string without line break at the end (unless the string + itself specifies one).
        +
        +
        Parameters:
        +
        s - the string to print.
        +
        +
      • +
      + + + +
        +
      • +

        flush

        +
        void flush()
        +
        Outputs all buffered messages to the console. Only necessary + if concurrent accesses must be avoided.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + -- cgit v1.2.3