SyntaxKeywords (sdn-apidoc 2.5.14 API)

All Known Implementing Classes:

Syntax, SyntaxFragment, SyntaxKeyword, SyntaxNode, SyntaxNodeExtension, SyntaxPackage, SyntaxParameter
```
public interface SyntaxKeywords
```
Null interface to hold various keyword definitions.

Author:

Thomas Vachuska

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KW_ACTION_NAME` Value of this keyword property specifies the name of the symbolic action.
`static String`	`KW_CLASS` Keyword identifying parser class attribute.
`static String`	`KW_CONSTRAINTS_PARSER` This package-level property allows one to extend the parameter validating framework by providing a comma separated list of constraints parser class names.
`static String`	`KW_CONSTRAINTS_TYPE` This optional parameter node property is similar to the KW_VALUE_TYPE property.
`static String`	`KW_DEFAULT` The value of this optional parameter-specific property will be parsed into a java object using that parameter's value parser during initial load.
`static String`	`KW_DESCRIPTION` Value of this property specifies a brief, usually a one-word descriptive term for the node.
`static String`	`KW_EXTENDS` The value of this property specifies the name of the node from which this node should inherit any of its properties.
`static String`	`KW_FLOATING` Value of this true/false property specifies whether the defining node is an anchored/positional one, or a floating/non-positional one.
`static String`	`KW_HELP_TEXT` Keyword property whose value contains a long descriptive text for a node.
`static String`	`KW_HELP_TOPICS` Value of this property specifies a comma-separated list of single-word help topics.
`static String`	`KW_NAME` Keyword denoting the node or property name; it should generally follow the Java identifier conventions.
`static String`	`KW_PACKAGE` Keyword identifying package element.
`static String`	`KW_PARAMETER` Keyword identifying parameter element.
`static String`	`KW_PARAMETER_PARSER` This package-level property allows one to extend the parameter parsing framework by providing a comma separated list of parameter parser class names.
`static String`	`KW_PRIORITY` Specifies the priority of the root syntax definitions.
`static String`	`KW_PROPERTY` Keyword identifying property element.
`static String`	`KW_RESOURCES` Keyword whose value names the resource bundle that should be used to resolve any local-specific values; value tokens prefixed with '%' do not represent the actual value, but rather are interpretted as the key, using which to obtain the actual value from the resource bundle.
`static String`	`KW_SUPER` This symbolic syntax node reference, when encountered in the usage string of a syntax fragment, will cause the defining fragment to inherit all of the floating syntax nodes contained in the parent's usage list.
`static String`	`KW_SYNTAX` Keyword identifying syntax element.
`static String`	`KW_USAGE` Keyword whose value contains a space-separated list of literal or resource reference keyword definitions, and references to other syntax nodes.
`static String`	`KW_VALUE` Keyword denoting the property value attribute.
`static String`	`KW_VALUE_TYPE` The value of this optional parameter node-specific property, is a type token that indicates which parameter parser should be used to convert the argument to the java object.
`static String`	`MAX_OCCURRENCES` The value of this fragment property, indicates the maximum number of times this parameter can be specified in a row.
`static String`	`MIN_OCCURRENCES` The value of this fragment property, indicates the minimum number of times this parameter must be present.
`static String`	`OPTIONAL` The value of this fragment property indicates whether the fragment is optional or not.

- Field Detail
  - KW_NAME
```
static final String KW_NAME
```
    Keyword denoting the node or property name; it should generally follow the Java identifier conventions.
    
    See Also:
    Constant Field Values
  - KW_RESOURCES
```
static final String KW_RESOURCES
```
    Keyword whose value names the resource bundle that should be used to resolve any local-specific values; value tokens prefixed with '%' do not represent the actual value, but rather are interpretted as the key, using which to obtain the actual value from the resource bundle. For example '%verbose' means that a property named 'verbose' would be looked up in the resource bundle and its value would be used in place of the '%verbose' token.
    If not present, the node will inherit its resource bundle from its defining container and if that fails from the node which it extends, if any.
    
    See Also:
    Constant Field Values
  - KW_FLOATING
```
static final String KW_FLOATING
```
    Value of this true/false property specifies whether the defining node is an anchored/positional one, or a floating/non-positional one. If not present, the node will inherit the value of this property from the parent node, i.e. the one it extends, if any. Default value is false, which means the node is an anchored one by default.
    
    See Also:
    Constant Field Values
  - KW_EXTENDS
```
static final String KW_EXTENDS
```
    The value of this property specifies the name of the node from which this node should inherit any of its properties. The name can be either the fully qualified name, such as 'common.verbosity' or the short one 'verbosity'. If the fully qualified name is not specified, the parser will look for a definition within the neares encapsulating scope all the way to the package scope. Therefore, references to nodes in other packages must always be fully qualified.
    
    See Also:
    Constant Field Values
  - KW_SUPER
```
static final String KW_SUPER
```
    This symbolic syntax node reference, when encountered in the usage string of a syntax fragment, will cause the defining fragment to inherit all of the floating syntax nodes contained in the parent's usage list. Applies only within the context of the usage property value.
    
    See Also:
    Constant Field Values
  - KW_USAGE
```
static final String KW_USAGE
```
    Keyword whose value contains a space-separated list of literal or resource reference keyword definitions, and references to other syntax nodes. References to all anchored nodes must be specified in the order in which they are anticipated on the command line. The ordering of floating nodes is not considered. If a node has this property, it becomes a syntax fragment.
    
    See Also:
    Constant Field Values
  - KW_PRIORITY
```
static final String KW_PRIORITY
```
    Specifies the priority of the root syntax definitions. Lower number means higher priority. Attempts to match arguments atr made on root syntax nodes, in the order of their priority. Value 0, thus makes the node an optional one, which means that if the parameter fails parsing and validation, the parser moves onto the next node without objections.
    
    See Also:
    Constant Field Values
  - OPTIONAL
```
static final String OPTIONAL
```
    The value of this fragment property indicates whether the fragment is optional or not. If it is, it forces min occurrences to 0 and max occurrences to 1. If this property is specified as true, the min and max occurrences properties will be ignored.
    
    See Also:
    Constant Field Values
  - MIN_OCCURRENCES
```
static final String MIN_OCCURRENCES
```
    The value of this fragment property, indicates the minimum number of times this parameter must be present. Defaults to value 1, i.e. the parameter must occur at least once. Value of -1, translates to Integer.MAX_VALUE and therefore (for all practical purposes) to unlimited number of occurrences.
    
    See Also:
    Constant Field Values
  - MAX_OCCURRENCES
```
static final String MAX_OCCURRENCES
```
    The value of this fragment property, indicates the maximum number of times this parameter can be specified in a row. Defaults to value 1, i.e. the parameter must occur at most once. Value of -1, translates to Integer.MAX_VALUE and therefore (for all practical purposes) to unlimited number of occurrences.
    
    See Also:
    Constant Field Values
  - KW_DESCRIPTION
```
static final String KW_DESCRIPTION
```
    Value of this property specifies a brief, usually a one-word descriptive term for the node. This term is used as part of the usage string. If absent, the short name of the node is taken as its description instead, although in that case, is not a localizable entity.
    
    See Also:
    Constant Field Values
  - KW_HELP_TOPICS
```
static final String KW_HELP_TOPICS
```
    Value of this property specifies a comma-separated list of single-word help topics. If absent, the string image of the first fixed node parameter is taken instead.
    
    See Also:
    Constant Field Values
  - KW_HELP_TEXT
```
static final String KW_HELP_TEXT
```
    Keyword property whose value contains a long descriptive text for a node. For root syntax nodes, this text is shown immediatelly following the usage string. For parameter nodes and syntax fragments, it is shown in a descriptive list in the following form:
```
    description           verbose help text (possibly multi-line)
        
```
    See Also:
    Constant Field Values
  - KW_ACTION_NAME
```
static final String KW_ACTION_NAME
```
    Value of this keyword property specifies the name of the symbolic action. A syntax fragment node that contain this property, becomes a root syntax node. How this is used really depends on the mechanism which uses the syntax parser. It could be a simple abstract name or, it could be a string specifying the JNDI URI to a particular EJB.
    
    See Also:
    Constant Field Values
  - KW_VALUE_TYPE
```
static final String KW_VALUE_TYPE
```
    The value of this optional parameter node-specific property, is a type token that indicates which parameter parser should be used to convert the argument to the java object. Type tokens of builtin parameter parsers are as follows:
  - 'string' - parses arg into a String object
  - 'strings' - parses arg into a Vector of String objects
  - 'number' - parses arg into a Number object
  - 'numbers' - parses arg into a Vector of Number objects
  - 'date' - parses arg into a Date instance
  - 'dates' - parses arg into a Vector of Date objects
  - 'file' - parses arg into a File object Other parsers can be registered via the KW_VALUE_TYPES property. Defaults to 'string' if absent.

See Also:: Constant Field Values

KW_CONSTRAINTS_TYPE
```
static final String KW_CONSTRAINTS_TYPE
```
This optional parameter node property is similar to the KW_VALUE_TYPE property. It allows one to specify a constraints parser that is separate from a parameter parser. A 'string' value counterpart could be a parser that generates a Constraints implementation which allows for validating strings against an ERE pattern for example. If absent, value defaults to the value of the KW_VALUE_TYPE property.

See Also:
Constant Field Values

KW_DEFAULT
```
static final String KW_DEFAULT
```
The value of this optional parameter-specific property will be parsed into a java object using that parameter's value parser during initial load. That value will serve as the default value in case the parameter was an optional one and whose counterpart argument was ommited during parsing.

See Also:
Constant Field Values

KW_PACKAGE
```
static final String KW_PACKAGE
```
Keyword identifying package element.

See Also:
Constant Field Values

KW_SYNTAX
```
static final String KW_SYNTAX
```
Keyword identifying syntax element.

See Also:
Constant Field Values

KW_PARAMETER
```
static final String KW_PARAMETER
```
Keyword identifying parameter element.

See Also:
Constant Field Values

KW_PROPERTY
```
static final String KW_PROPERTY
```
Keyword identifying property element.

See Also:
Constant Field Values

KW_PARAMETER_PARSER
```
static final String KW_PARAMETER_PARSER
```
This package-level property allows one to extend the parameter parsing framework by providing a comma separated list of parameter parser class names.

See Also:
Constant Field Values

KW_CONSTRAINTS_PARSER
```
static final String KW_CONSTRAINTS_PARSER
```
This package-level property allows one to extend the parameter validating framework by providing a comma separated list of constraints parser class names.

See Also:
Constant Field Values

KW_CLASS
```
static final String KW_CLASS
```
Keyword identifying parser class attribute.

See Also:
Constant Field Values

KW_VALUE
```
static final String KW_VALUE
```
Keyword denoting the property value attribute.

See Also:
Constant Field Values

Interface SyntaxKeywords

Field Summary

Field Detail

KW_NAME

KW_RESOURCES

KW_FLOATING

KW_EXTENDS

KW_SUPER

KW_USAGE

KW_PRIORITY

OPTIONAL

MIN_OCCURRENCES

MAX_OCCURRENCES

KW_DESCRIPTION

KW_HELP_TOPICS

KW_HELP_TEXT

KW_ACTION_NAME

KW_VALUE_TYPE

KW_CONSTRAINTS_TYPE

KW_DEFAULT

KW_PACKAGE

KW_SYNTAX

KW_PARAMETER

KW_PROPERTY

KW_PARAMETER_PARSER

KW_CONSTRAINTS_PARSER

KW_CLASS

KW_VALUE