chrriis.dj.nativeswing
Enum NSSystemProperty

java.lang.Object
  extended by java.lang.Enum<NSSystemProperty>
      extended by chrriis.dj.nativeswing.NSSystemProperty
All Implemented Interfaces:
Serializable, Comparable<NSSystemProperty>

public enum NSSystemProperty
extends Enum<NSSystemProperty>

A class that exposes all the system properties used by DJ Native Swing.

Author:
Christopher Deckers, Stefan Fussenegger

Enum Constant Summary
COMPONENTS_DEBUG_PRINTOPTIONS
          nativeswing.components.debug.printOptions = true/false (default: false)
Set whether the options used to create a component should be printed.
COMPONENTS_DEBUG_PRINTSHAPECOMPUTING
          nativeswing.components.debug.printShapeComputing = true/false (default: false)
Set whether the computation of the shape applied to the native component (when the visibility constraint option is active) should be printed.
COMPONENTS_FORCESINGLERECTANGLESHAPES
          nativeswing.components.forceSingleRectangleShapes = true/false (default: false) Certain platforms only support shapes for native components that resolve to single rectangles.
DEPENDENCIES_CHECKVERSIONS
          nativeswing.dependencies.checkVersions = true/false (default: true)
Set whether the versions of the dependencies should be checked when possible.
INTEGRATION_ACTIVE
          nativeswing.integration.active = true/false (default: true)
Set whether native integration should be active.
LOCALHOSTADDRESS
          nativeswing.localhostAddress = <String> or "_localhost_" (default: auto-detect, usually 127.0.0.1)
Set the address that is used as the local host address for all the internal communication channels that require a sockets (local web server, etc.).
LOCALHOSTADDRESS_DEBUG_PRINT
          nativeswing.localhostAddress.debug.print = true/false (default: false)
Set whether the address found as the local host address should be printed.
LOCALHOSTADDRESS_DEBUG_PRINTDETECTION
          nativeswing.localhostAddress.debug.printDetection = true/false (default: false)
Set whether to print the steps of local host address detection.
WEBSERVER_DEBUG_PRINTDATA
          nativeswing.webserver.debug.printData = true/false/ (default: false)
Set whether the web server should print the data it sends (or how many bytes to print).
WEBSERVER_DEBUG_PRINTPORT
          nativeswing.webserver.debug.printPort = true/false (default: false)
Set whether the port that is used by the embedded web server should be printed.
WEBSERVER_DEBUG_PRINTREQUESTS
          nativeswing.webserver.debug.printRequests = true/false (default: false)
Set whether the web server should print the requests it receives, along with the result (200 or 404).
 
Method Summary
 String get()
           
 String get(String defaultValue)
           
 String getName()
           
 boolean isReadOnly()
          whether this property should not be modified (i.e.
 String set(String value)
           
 String toDebugString()
           
 String toString()
           
static NSSystemProperty valueOf(String name)
          Returns the enum constant of this type with the specified name.
static NSSystemProperty[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LOCALHOSTADDRESS

public static final NSSystemProperty LOCALHOSTADDRESS
nativeswing.localhostAddress = <String> or "_localhost_" (default: auto-detect, usually 127.0.0.1)
Set the address that is used as the local host address for all the internal communication channels that require a sockets (local web server, etc.).


LOCALHOSTADDRESS_DEBUG_PRINTDETECTION

public static final NSSystemProperty LOCALHOSTADDRESS_DEBUG_PRINTDETECTION
nativeswing.localhostAddress.debug.printDetection = true/false (default: false)
Set whether to print the steps of local host address detection.


LOCALHOSTADDRESS_DEBUG_PRINT

public static final NSSystemProperty LOCALHOSTADDRESS_DEBUG_PRINT
nativeswing.localhostAddress.debug.print = true/false (default: false)
Set whether the address found as the local host address should be printed.


WEBSERVER_DEBUG_PRINTPORT

public static final NSSystemProperty WEBSERVER_DEBUG_PRINTPORT
nativeswing.webserver.debug.printPort = true/false (default: false)
Set whether the port that is used by the embedded web server should be printed.


WEBSERVER_DEBUG_PRINTREQUESTS

public static final NSSystemProperty WEBSERVER_DEBUG_PRINTREQUESTS
nativeswing.webserver.debug.printRequests = true/false (default: false)
Set whether the web server should print the requests it receives, along with the result (200 or 404).


WEBSERVER_DEBUG_PRINTDATA

public static final NSSystemProperty WEBSERVER_DEBUG_PRINTDATA
nativeswing.webserver.debug.printData = true/false/ (default: false)
Set whether the web server should print the data it sends (or how many bytes to print).


COMPONENTS_DEBUG_PRINTOPTIONS

public static final NSSystemProperty COMPONENTS_DEBUG_PRINTOPTIONS
nativeswing.components.debug.printOptions = true/false (default: false)
Set whether the options used to create a component should be printed.


COMPONENTS_DEBUG_PRINTSHAPECOMPUTING

public static final NSSystemProperty COMPONENTS_DEBUG_PRINTSHAPECOMPUTING
nativeswing.components.debug.printShapeComputing = true/false (default: false)
Set whether the computation of the shape applied to the native component (when the visibility constraint option is active) should be printed.


COMPONENTS_FORCESINGLERECTANGLESHAPES

public static final NSSystemProperty COMPONENTS_FORCESINGLERECTANGLESHAPES
nativeswing.components.forceSingleRectangleShapes = true/false (default: false) Certain platforms only support shapes for native components that resolve to single rectangles. Developers who want to develop on a different platform with the same constraint can force that behavior for consistency.


INTEGRATION_ACTIVE

public static final NSSystemProperty INTEGRATION_ACTIVE
nativeswing.integration.active = true/false (default: true)
Set whether native integration should be active.


DEPENDENCIES_CHECKVERSIONS

public static final NSSystemProperty DEPENDENCIES_CHECKVERSIONS
nativeswing.dependencies.checkVersions = true/false (default: true)
Set whether the versions of the dependencies should be checked when possible.

Method Detail

values

public static NSSystemProperty[] 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 (NSSystemProperty c : NSSystemProperty.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static NSSystemProperty valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

get

public String get()
Returns:
the string value of the system property, or null if there is no property with that key.
See Also:
System.getProperty(String), AccessController.doPrivileged(PrivilegedAction)

get

public String get(String defaultValue)
Parameters:
defaultValue - the default value to return if the property is not defined.
Returns:
the string value of the system property, or the default value if there is no property with that key.
See Also:
System.getProperty(String), AccessController.doPrivileged(PrivilegedAction)

set

public String set(String value)
Parameters:
value - the new value
Throws:
UnsupportedOperationException - if this property is read-only
See Also:
System.setProperty(String, String), AccessController.doPrivileged(PrivilegedAction), isReadOnly()

getName

public String getName()
Returns:
name of this property

isReadOnly

public boolean isReadOnly()
whether this property should not be modified (i.e. "read-only"). Note that it is possible to use System.setProperty(String, String) directly. It's use is discouraged though (as it might not have the desired effect)

Returns:
true if this property should not be modified

toString

public String toString()
Overrides:
toString in class Enum<NSSystemProperty>
Returns:
property value (same as get()
See Also:
get()

toDebugString

public String toDebugString()
Returns:
a string representation of this object (e.g. "OS_NAME: os.name=Linux (read-only)")