ConfigurationInfo (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.config.ConfigurationInfo

```
public class ConfigurationInfo
extends Object
```
Meta information for each configuration options. It is created by ConfigurationBuffer.loadCache(java.lang.Class<? extends org.apache.flex.compiler.config.Configuration>, org.apache.flex.compiler.internal.config.IConfigurationFilter) from either annotations or public static ConfigurationInfo getFooInfo(); methods in Configuration class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`aliases`
`protected boolean`	`allowMultiple`
`protected int`	`argcount`
`protected Class<?>`	`argNameGeneratorClass`
`protected String[]`	`argnames`
`protected Class<?>[]`	`argtypes`
`protected String[]`	`defaultArgValues`
`protected String`	`deprecatedMessage`
`protected String`	`deprecatedReplacement`
`protected String`	`deprecatedSince`
`static int`	`INFINITE_ARGS`
`protected boolean`	`isAdvanced`
`boolean`	`isCompcOnly` True if only `compc` client can use this option.
`protected boolean`	`isDeprecated`
`protected boolean`	`isDisplayed`
`protected boolean`	`isFlexOnly`
`protected boolean`	`isGreedy`
`protected boolean`	`isHidden`
`protected boolean`	`isPath`
`protected boolean`	`isRemoved`
`protected boolean`	`isRequired`
`static int`	`NOT_SET`
`protected String[]`	`prerequisites`
`protected String[]`	`softPrerequisites`

Constructor Summary

Constructors
Constructor and Description
`ConfigurationInfo()` This ctor is used when everything can be introspected off the setter method, or else when the names/types are provided by method overrides rather than ctor arguments
`ConfigurationInfo(int argcount)` Simple ctor for restricting the number of arguments.
`ConfigurationInfo(int argcount, String argname)` Use this ctor when you want to set a single list of some number of identically named args
`ConfigurationInfo(int argcount, String[] argnames)` More unusual ctor, this would let you have the first few args named one thing, the rest named something else.
`ConfigurationInfo(String[] argnames)` Simple ctor for naming the arguments.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allowMultiple()` Variables are generally only allowed to be set once in a given file/cmdline.
`boolean`	`doChecksum()`
`String[]`	`getAliases()` Return an array of other names for this variable.
`int`	`getArgCount()`
`String`	`getArgName(int argnum)` Return the name of each parameter.
`Class<?>`	`getArgType(int argnum)` Return the type of each parameter.
`String[]`	`getDefaultArgValues()` Get any default values for an argument
`String`	`getDeprecatedMessage()`
`String`	`getDeprecatedReplacement()`
`String`	`getDeprecatedSince()`
`protected Method`	`getGetterMethod()`
`String[]`	`getPrerequisites()` Return variable names that should be set before this one.
`protected Method`	`getSetterMethod()`
`String[]`	`getSoftPrerequisites()` Prerequisites which should be set before this one if they exist
`boolean`	`isAdvanced()` Override to make a variable hidden by default (i.e. you need -advanced on the cmdline)
`boolean`	`isDeprecated()`
`boolean`	`isDisplayed()` Override to prevent printing when dumping configuration
`boolean`	`isFlexOnly()`
`boolean`	`isGreedy()` Magic used by the command line configurator only at the moment to decide whether this variable should eat all subsequent arguments.
`boolean`	`isHidden()` Override to make a variable completely hidden
`boolean`	`isPath()`
`boolean`	`isRemoved()`
`boolean`	`isRequired()` If a variable -must- be set, override this
`protected void`	`setGetterMethod(Method getter)`
`protected void`	`setSetterMethod(Method setter)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NOT_SET
```
public static final int NOT_SET
```
    See Also:
    Constant Field Values
  - INFINITE_ARGS
```
public static final int INFINITE_ARGS
```
    See Also:
    Constant Field Values
  - argcount
```
protected int argcount
```
  - defaultArgValues
```
protected String[] defaultArgValues
```
  - argNameGeneratorClass
```
protected Class<?> argNameGeneratorClass
```
  - argnames
```
protected String[] argnames
```
  - argtypes
```
protected Class<?>[] argtypes
```
  - prerequisites
```
protected String[] prerequisites
```
  - softPrerequisites
```
protected String[] softPrerequisites
```
  - allowMultiple
```
protected boolean allowMultiple
```
  - aliases
```
protected String[] aliases
```
  - isAdvanced
```
protected boolean isAdvanced
```
  - isHidden
```
protected boolean isHidden
```
  - isDisplayed
```
protected boolean isDisplayed
```
  - isRequired
```
protected boolean isRequired
```
  - isGreedy
```
protected boolean isGreedy
```
  - isPath
```
protected boolean isPath
```
  - deprecatedMessage
```
protected String deprecatedMessage
```
  - isDeprecated
```
protected boolean isDeprecated
```
  - deprecatedReplacement
```
protected String deprecatedReplacement
```
  - deprecatedSince
```
protected String deprecatedSince
```
  - isRemoved
```
protected boolean isRemoved
```
  - isFlexOnly
```
protected boolean isFlexOnly
```
  - isCompcOnly
```
public boolean isCompcOnly
```
    True if only compc client can use this option.
- Constructor Detail
  - ConfigurationInfo
```
public ConfigurationInfo()
```
    This ctor is used when everything can be introspected off the setter method, or else when the names/types are provided by method overrides rather than ctor arguments
  - ConfigurationInfo
```
public ConfigurationInfo(int argcount)
```
    Simple ctor for restricting the number of arguments.
    
    Parameters:
    argcount - number of args, -1 for an infinite list
  - ConfigurationInfo
```
public ConfigurationInfo(String[] argnames)
```
    Simple ctor for naming the arguments.
    
    Parameters:
    argnames - list of argnames, argcount will default to # of elements
  - ConfigurationInfo
```
public ConfigurationInfo(int argcount,
                 String argname)
```
    Use this ctor when you want to set a single list of some number of identically named args
    
    Parameters:
    argcount - number of arguments (-1 for infinite)
    argname - name of each argument
  - ConfigurationInfo
```
public ConfigurationInfo(int argcount,
                 String[] argnames)
```
    More unusual ctor, this would let you have the first few args named one thing, the rest named something else. It is far more likely that you want a constrained list of names or else an arbitrary list of identical names.
    
    Parameters:
    argcount - number of arguments
    argnames - array of argument names
- Method Detail
  - getArgCount
```
public final int getArgCount()
```
  - getDefaultArgValues
```
public final String[] getDefaultArgValues()
```
    Get any default values for an argument
    
    Returns:
    an array of default argument values. May be null
  - getArgName
```
public String getArgName(int argnum)
```
    Return the name of each parameter. The default implementation is usually sufficient for simple cases, but one could do wacky things here like support an infinite list of alternating arg names.
    
    Parameters:
    argnum - The argument number.
    
    Returns:
    name of argument
  - getArgType
```
public final Class<?> getArgType(int argnum)
```
    Return the type of each parameter. This is computed based on your setter, and cannot be overridden
    
    Parameters:
    argnum - The argument number.
  - getPrerequisites
```
public String[] getPrerequisites()
```
    Return variable names that should be set before this one. The buffer is always set such that it tries to set all variables at a given level before setting child values, but you could override by using this. Its probably a bad idea to depend on children, though. It is unnecessary to set parent vars as prerequisites, since they are implicitly set first
  - getSoftPrerequisites
```
public String[] getSoftPrerequisites()
```
    Prerequisites which should be set before this one if they exist
  - allowMultiple
```
public boolean allowMultiple()
```
    Variables are generally only allowed to be set once in a given file/cmdline. It is sometimes useful to allow the same set multiple times in order to aggregate values.
    
    Returns:
    true if the setter can be called multiple times
  - getAliases
```
public String[] getAliases()
```
    Return an array of other names for this variable.
  - isAdvanced
```
public boolean isAdvanced()
```
    Override to make a variable hidden by default (i.e. you need -advanced on the cmdline)
  - isHidden
```
public boolean isHidden()
```
    Override to make a variable completely hidden
  - isDisplayed
```
public boolean isDisplayed()
```
    Override to prevent printing when dumping configuration
  - isRequired
```
public boolean isRequired()
```
    If a variable -must- be set, override this
  - isGreedy
```
public boolean isGreedy()
```
    Magic used by the command line configurator only at the moment to decide whether this variable should eat all subsequent arguments. Useful for -help...
  - isPath
```
public boolean isPath()
```
  - doChecksum
```
public boolean doChecksum()
```
  - getDeprecatedMessage
```
public String getDeprecatedMessage()
```
  - isDeprecated
```
public boolean isDeprecated()
```
  - getDeprecatedReplacement
```
public String getDeprecatedReplacement()
```
  - getDeprecatedSince
```
public String getDeprecatedSince()
```
  - isRemoved
```
public boolean isRemoved()
```
    Returns:
    True indicates that the option is no longer supported and will not have any affect.
  - isFlexOnly
```
public boolean isFlexOnly()
```
    Returns:
    True the option requires Flex in order to be useful.
  - setSetterMethod
```
protected final void setSetterMethod(Method setter)
```
  - getSetterMethod
```
protected final Method getSetterMethod()
```
  - setGetterMethod
```
protected final void setGetterMethod(Method getter)
```
  - getGetterMethod
```
protected final Method getGetterMethod()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ConfigurationInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOT_SET

INFINITE_ARGS

argcount

defaultArgValues

argNameGeneratorClass

argnames

argtypes

prerequisites

softPrerequisites

allowMultiple

aliases

isAdvanced

isHidden

isDisplayed

isRequired

isGreedy

isPath

deprecatedMessage

isDeprecated

deprecatedReplacement

deprecatedSince

isRemoved

isFlexOnly

isCompcOnly

Constructor Detail

ConfigurationInfo

ConfigurationInfo

ConfigurationInfo

ConfigurationInfo

ConfigurationInfo

Method Detail

getArgCount

getDefaultArgValues

getArgName

getArgType

getPrerequisites

getSoftPrerequisites

allowMultiple

getAliases

isAdvanced

isHidden

isDisplayed

isRequired

isGreedy

isPath

doChecksum

getDeprecatedMessage

isDeprecated

getDeprecatedReplacement

getDeprecatedSince

isRemoved

isFlexOnly

setSetterMethod

getSetterMethod

setGetterMethod

getGetterMethod

toString