Configuration (Apache Royale: Compiler: AS3/MXML Code Linter 0.9.10 API)

java.lang.Object
- org.apache.royale.linter.config.Configuration

public class Configuration
extends Object

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,String>`	`getAliases()`
`boolean`	`getClassName()`
`Collection<org.apache.royale.compiler.problems.ICompilerProblem>`	`getConfigurationProblems()` Get the configuration problems.
`boolean`	`getConstantName()`
`boolean`	`getEmptyComment()`
`boolean`	`getEmptyFunctionBody()`
`boolean`	`getEmptyNestedBlock()`
`boolean`	`getEmptyStatement()`
`boolean`	`getFieldName()`
`List<String>`	`getFiles()`
`boolean`	`getFunctionName()`
`boolean`	`getIgnoreParsingProblems()`
`boolean`	`getInterfaceName()`
`String`	`getLineCommentPosition()`
`String`	`getLoadConfig()`
`boolean`	`getLocalVarParamName()`
`boolean`	`getLocalVarShadowsField()`
`int`	`getMaxBlockDepth()`
`int`	`getMaxParams()`
`boolean`	`getMissingAsdoc()`
`boolean`	`getMissingConstructorSuper()`
`boolean`	`getMissingNamespace()`
`boolean`	`getMissingSemicolon()`
`boolean`	`getMissingType()`
`boolean`	`getMxmlEmptyAttr()`
`boolean`	`getMxmlId()`
`boolean`	`getNoAnyType()`
`boolean`	`getNoBooleanEquality()`
`boolean`	`getNoConstructorDispatch()`
`boolean`	`getNoConstructorReturnType()`
`boolean`	`getNoDuplicateKeys()`
`boolean`	`getNoDynamicClass()`
`boolean`	`getNoIfBoolean()`
`boolean`	`getNoLeadingZero()`
`boolean`	`getNoSparseArray()`
`boolean`	`getNoStringEvent()`
`boolean`	`getNoThisClosure()`
`boolean`	`getNoTrace()`
`boolean`	`getNoVoidOperator()`
`boolean`	`getNoWildcardImport()`
`boolean`	`getNoWith()`
`boolean`	`getOverrideSuper()`
`boolean`	`getPackageName()`
`boolean`	`getSkipLocalConfigFile()`
`boolean`	`getStaticConstants()`
`boolean`	`getStrictEquality()`
`boolean`	`getSwitchDefault()`
`boolean`	`getUnsafeNegation()`
`boolean`	`getValidTypeof()`
`boolean`	`getVarsOnTop()`
`protected String`	`resolvePathStrict(String path, ConfigurationValue cv)`
`void`	`setClassName(ConfigurationValue cv, boolean b)`
`void`	`setConstantName(ConfigurationValue cv, boolean b)`
`void`	`setEmptyComment(ConfigurationValue cv, boolean b)`
`void`	`setEmptyFunctionBody(ConfigurationValue cv, boolean b)`
`void`	`setEmptyNestedBlock(ConfigurationValue cv, boolean b)`
`void`	`setEmptyStatement(ConfigurationValue cv, boolean b)`
`void`	`setFieldName(ConfigurationValue cv, boolean b)`
`void`	`setFiles(ConfigurationValue cv, List<String> args)`
`void`	`setFunctionName(ConfigurationValue cv, boolean b)`
`void`	`setHelp(ConfigurationValue cv, String[] keywords)` dummy, just a trigger for help text
`void`	`setIgnoreParsingProblems(ConfigurationValue cv, boolean b)`
`void`	`setInterfaceName(ConfigurationValue cv, boolean b)`
`void`	`setLineCommentPosition(ConfigurationValue cv, String s)`
`void`	`setLoadConfig(ConfigurationValue cv, String filename)` Since `ConfigurationBuffer` loads the "load-config" files, the value of this configuration option isn't intersting to the rest part of the compiler.
`void`	`setLocalVarParamName(ConfigurationValue cv, boolean b)`
`void`	`setLocalVarShadowsField(ConfigurationValue cv, boolean b)`
`void`	`setMaxBlockDepth(ConfigurationValue cv, int i)`
`void`	`setMaxParams(ConfigurationValue cv, int i)`
`void`	`setMissingAsdoc(ConfigurationValue cv, boolean b)`
`void`	`setMissingConstructorSuper(ConfigurationValue cv, boolean b)`
`void`	`setMissingNamespace(ConfigurationValue cv, boolean b)`
`void`	`setMissingSemicolon(ConfigurationValue cv, boolean b)`
`void`	`setMissingType(ConfigurationValue cv, boolean b)`
`void`	`setMxmlEmptyAttr(ConfigurationValue cv, boolean b)`
`void`	`setMxmlId(ConfigurationValue cv, boolean b)`
`void`	`setNoAnyType(ConfigurationValue cv, boolean b)`
`void`	`setNoBooleanEquality(ConfigurationValue cv, boolean b)`
`void`	`setNoConstructorDispatch(ConfigurationValue cv, boolean b)`
`void`	`setNoConstructorReturnType(ConfigurationValue cv, boolean b)`
`void`	`setNoDuplicateKeys(ConfigurationValue cv, boolean b)`
`void`	`setNoDynamicClass(ConfigurationValue cv, boolean b)`
`void`	`setNoIfBoolean(ConfigurationValue cv, boolean b)`
`void`	`setNoLeadingZero(ConfigurationValue cv, boolean b)`
`void`	`setNoSparseArray(ConfigurationValue cv, boolean b)`
`void`	`setNoStringEvent(ConfigurationValue cv, boolean b)`
`void`	`setNoThisClosure(ConfigurationValue cv, boolean b)`
`void`	`setNoTrace(ConfigurationValue cv, boolean b)`
`void`	`setNoVoidOperator(ConfigurationValue cv, boolean b)`
`void`	`setNoWildcardImport(ConfigurationValue cv, boolean b)`
`void`	`setNoWith(ConfigurationValue cv, boolean b)`
`void`	`setOverrideSuper(ConfigurationValue cv, boolean b)`
`void`	`setPackageName(ConfigurationValue cv, boolean b)`
`void`	`setPathResolver(org.apache.royale.compiler.common.IPathResolver pathResolver)` Set a path resolver to resolver files relative to a configuration.
`void`	`setSkipLocalConfigFile(ConfigurationValue cv, boolean b)`
`void`	`setStaticConstants(ConfigurationValue cv, boolean b)`
`void`	`setStrictEquality(ConfigurationValue cv, boolean b)`
`void`	`setSwitchDefault(ConfigurationValue cv, boolean b)`
`void`	`setUnsafeNegation(ConfigurationValue cv, boolean b)`
`void`	`setValidTypeof(ConfigurationValue cv, boolean b)`
`void`	`setVarsOnTop(ConfigurationValue cv, boolean b)`
`void`	`setVersion(ConfigurationValue cv, boolean value)` Dummy option.
`void`	`validate(ConfigurationBuffer configurationBuffer)` Validate configuration options values.

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

Constructor Detail
- Configuration
```
public Configuration()
```

Method Detail

getAliases

public static Map<String,String> getAliases()

setPathResolver
```
public void setPathResolver(org.apache.royale.compiler.common.IPathResolver pathResolver)
```
Set a path resolver to resolver files relative to a configuration. Files inside of configuration files are resolved relative to those configuration files and files on the command line are resolved relative to the root directory of the compile.

Parameters:

pathResolver - a path resolver for this configuration. May not be null.

getConfigurationProblems
```
public Collection<org.apache.royale.compiler.problems.ICompilerProblem> getConfigurationProblems()
```
Get the configuration problems. This should be called after the configuration has been processed.

Returns:

a collection of fatal and non-fatal configuration problems.

validate
```
public void validate(ConfigurationBuffer configurationBuffer)
              throws org.apache.royale.compiler.exceptions.ConfigurationException
```
Validate configuration options values.

Parameters:

configurationBuffer - Configuration buffer.

Throws:

org.apache.royale.compiler.exceptions.ConfigurationException - Error.

setHelp

public void setHelp(ConfigurationValue cv,
                    String[] keywords)

dummy, just a trigger for help text

setVersion

public void setVersion(ConfigurationValue cv,
                       boolean value)

Dummy option. Just a trigger for version info.

getLoadConfig
```
public String getLoadConfig()
```
Returns:

Normalized path to a Flex configuration file.

setLoadConfig
```
public void setLoadConfig(ConfigurationValue cv,
                          String filename)
                   throws org.apache.royale.compiler.exceptions.ConfigurationException
```
Since ConfigurationBuffer loads the "load-config" files, the value of this configuration option isn't intersting to the rest part of the compiler.

Throws:

org.apache.royale.compiler.exceptions.ConfigurationException

getFiles
```
public List<String> getFiles()
```
Returns:

A list of filespecs. It's the default variable for command line.

setFiles

public void setFiles(ConfigurationValue cv,
                     List<String> args)
              throws org.apache.royale.compiler.exceptions.ConfigurationException

Throws:: org.apache.royale.compiler.exceptions.ConfigurationException

getSkipLocalConfigFile

public boolean getSkipLocalConfigFile()

setSkipLocalConfigFile

public void setSkipLocalConfigFile(ConfigurationValue cv,
                                   boolean b)

getIgnoreParsingProblems

public boolean getIgnoreParsingProblems()

setIgnoreParsingProblems

public void setIgnoreParsingProblems(ConfigurationValue cv,
                                     boolean b)

getClassName
```
public boolean getClassName()
```

setClassName

public void setClassName(ConfigurationValue cv,
                         boolean b)

getConstantName
```
public boolean getConstantName()
```

setConstantName

public void setConstantName(ConfigurationValue cv,
                            boolean b)

getEmptyComment
```
public boolean getEmptyComment()
```

setEmptyComment

public void setEmptyComment(ConfigurationValue cv,
                            boolean b)

getEmptyFunctionBody
```
public boolean getEmptyFunctionBody()
```

setEmptyFunctionBody

public void setEmptyFunctionBody(ConfigurationValue cv,
                                 boolean b)

getEmptyNestedBlock
```
public boolean getEmptyNestedBlock()
```

setEmptyNestedBlock

public void setEmptyNestedBlock(ConfigurationValue cv,
                                boolean b)

getEmptyStatement
```
public boolean getEmptyStatement()
```

setEmptyStatement

public void setEmptyStatement(ConfigurationValue cv,
                              boolean b)

getFieldName
```
public boolean getFieldName()
```

setFieldName

public void setFieldName(ConfigurationValue cv,
                         boolean b)

getFunctionName
```
public boolean getFunctionName()
```

setFunctionName

public void setFunctionName(ConfigurationValue cv,
                            boolean b)

getInterfaceName
```
public boolean getInterfaceName()
```

setInterfaceName

public void setInterfaceName(ConfigurationValue cv,
                             boolean b)

getLineCommentPosition

public String getLineCommentPosition()

setLineCommentPosition

public void setLineCommentPosition(ConfigurationValue cv,
                                   String s)

getLocalVarParamName
```
public boolean getLocalVarParamName()
```

setLocalVarParamName

public void setLocalVarParamName(ConfigurationValue cv,
                                 boolean b)

getLocalVarShadowsField

public boolean getLocalVarShadowsField()

setLocalVarShadowsField

public void setLocalVarShadowsField(ConfigurationValue cv,
                                    boolean b)

getMaxBlockDepth
```
public int getMaxBlockDepth()
```

setMaxBlockDepth

public void setMaxBlockDepth(ConfigurationValue cv,
                             int i)

getMaxParams
```
public int getMaxParams()
```

setMaxParams

public void setMaxParams(ConfigurationValue cv,
                         int i)

getMissingAsdoc
```
public boolean getMissingAsdoc()
```

setMissingAsdoc

public void setMissingAsdoc(ConfigurationValue cv,
                            boolean b)

getMissingConstructorSuper

public boolean getMissingConstructorSuper()

setMissingConstructorSuper

public void setMissingConstructorSuper(ConfigurationValue cv,
                                       boolean b)

getMissingNamespace
```
public boolean getMissingNamespace()
```

setMissingNamespace

public void setMissingNamespace(ConfigurationValue cv,
                                boolean b)

getMissingSemicolon
```
public boolean getMissingSemicolon()
```

setMissingSemicolon

public void setMissingSemicolon(ConfigurationValue cv,
                                boolean b)

getMissingType
```
public boolean getMissingType()
```

setMissingType

public void setMissingType(ConfigurationValue cv,
                           boolean b)

getMxmlEmptyAttr
```
public boolean getMxmlEmptyAttr()
```

setMxmlEmptyAttr

public void setMxmlEmptyAttr(ConfigurationValue cv,
                             boolean b)

getMxmlId
```
public boolean getMxmlId()
```

setMxmlId

public void setMxmlId(ConfigurationValue cv,
                      boolean b)

getNoAnyType
```
public boolean getNoAnyType()
```

setNoAnyType

public void setNoAnyType(ConfigurationValue cv,
                         boolean b)

getNoBooleanEquality
```
public boolean getNoBooleanEquality()
```

setNoBooleanEquality

public void setNoBooleanEquality(ConfigurationValue cv,
                                 boolean b)

getNoConstructorDispatch

public boolean getNoConstructorDispatch()

setNoConstructorDispatch

public void setNoConstructorDispatch(ConfigurationValue cv,
                                     boolean b)

getNoConstructorReturnType

public boolean getNoConstructorReturnType()

setNoConstructorReturnType

public void setNoConstructorReturnType(ConfigurationValue cv,
                                       boolean b)

getNoDuplicateKeys
```
public boolean getNoDuplicateKeys()
```

setNoDuplicateKeys

public void setNoDuplicateKeys(ConfigurationValue cv,
                               boolean b)

getNoDynamicClass
```
public boolean getNoDynamicClass()
```

setNoDynamicClass

public void setNoDynamicClass(ConfigurationValue cv,
                              boolean b)

getNoIfBoolean
```
public boolean getNoIfBoolean()
```

setNoIfBoolean

public void setNoIfBoolean(ConfigurationValue cv,
                           boolean b)

getNoLeadingZero
```
public boolean getNoLeadingZero()
```

setNoLeadingZero

public void setNoLeadingZero(ConfigurationValue cv,
                             boolean b)

getNoSparseArray
```
public boolean getNoSparseArray()
```

setNoSparseArray

public void setNoSparseArray(ConfigurationValue cv,
                             boolean b)

getNoStringEvent
```
public boolean getNoStringEvent()
```

setNoStringEvent

public void setNoStringEvent(ConfigurationValue cv,
                             boolean b)

getNoThisClosure
```
public boolean getNoThisClosure()
```

setNoThisClosure

public void setNoThisClosure(ConfigurationValue cv,
                             boolean b)

getNoTrace
```
public boolean getNoTrace()
```

setNoTrace

public void setNoTrace(ConfigurationValue cv,
                       boolean b)

getNoVoidOperator
```
public boolean getNoVoidOperator()
```

setNoVoidOperator

public void setNoVoidOperator(ConfigurationValue cv,
                              boolean b)

getNoWildcardImport
```
public boolean getNoWildcardImport()
```

setNoWildcardImport

public void setNoWildcardImport(ConfigurationValue cv,
                                boolean b)

getNoWith
```
public boolean getNoWith()
```

setNoWith

public void setNoWith(ConfigurationValue cv,
                      boolean b)

getOverrideSuper
```
public boolean getOverrideSuper()
```

setOverrideSuper

public void setOverrideSuper(ConfigurationValue cv,
                             boolean b)

getPackageName
```
public boolean getPackageName()
```

setPackageName

public void setPackageName(ConfigurationValue cv,
                           boolean b)

getStaticConstants
```
public boolean getStaticConstants()
```

setStaticConstants

public void setStaticConstants(ConfigurationValue cv,
                               boolean b)

getStrictEquality
```
public boolean getStrictEquality()
```

setStrictEquality

public void setStrictEquality(ConfigurationValue cv,
                              boolean b)

getSwitchDefault
```
public boolean getSwitchDefault()
```

setSwitchDefault

public void setSwitchDefault(ConfigurationValue cv,
                             boolean b)

getUnsafeNegation
```
public boolean getUnsafeNegation()
```

setUnsafeNegation

public void setUnsafeNegation(ConfigurationValue cv,
                              boolean b)

getValidTypeof
```
public boolean getValidTypeof()
```

setValidTypeof

public void setValidTypeof(ConfigurationValue cv,
                           boolean b)

getVarsOnTop
```
public boolean getVarsOnTop()
```

setVarsOnTop

public void setVarsOnTop(ConfigurationValue cv,
                         boolean b)

resolvePathStrict
```
protected String resolvePathStrict(String path,
                                   ConfigurationValue cv)
                            throws org.apache.royale.compiler.exceptions.ConfigurationException.CannotOpen
```
Parameters:

path - A path to resolve.

cv - Configuration context.

Returns:

A single normalized resolved file. If the path could be expanded into more than one path, then use resolvePathsStrict

Throws:

org.apache.royale.compiler.exceptions.ConfigurationException.CannotOpen

Class Configuration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Configuration

Method Detail

getAliases

setPathResolver

getConfigurationProblems

validate

setHelp

setVersion

getLoadConfig

setLoadConfig

getFiles

setFiles

getSkipLocalConfigFile

setSkipLocalConfigFile

getIgnoreParsingProblems

setIgnoreParsingProblems

getClassName

setClassName

getConstantName

setConstantName

getEmptyComment

setEmptyComment

getEmptyFunctionBody

setEmptyFunctionBody

getEmptyNestedBlock

setEmptyNestedBlock

getEmptyStatement

setEmptyStatement

getFieldName

setFieldName

getFunctionName

setFunctionName

getInterfaceName

setInterfaceName

getLineCommentPosition

setLineCommentPosition

getLocalVarParamName

setLocalVarParamName

getLocalVarShadowsField

setLocalVarShadowsField

getMaxBlockDepth

setMaxBlockDepth

getMaxParams

setMaxParams

getMissingAsdoc

setMissingAsdoc

getMissingConstructorSuper

setMissingConstructorSuper

getMissingNamespace

setMissingNamespace

getMissingSemicolon

setMissingSemicolon

getMissingType

setMissingType

getMxmlEmptyAttr

setMxmlEmptyAttr

getMxmlId

setMxmlId

getNoAnyType

setNoAnyType

getNoBooleanEquality

setNoBooleanEquality

getNoConstructorDispatch

setNoConstructorDispatch

getNoConstructorReturnType

setNoConstructorReturnType

getNoDuplicateKeys

setNoDuplicateKeys

getNoDynamicClass

setNoDynamicClass

getNoIfBoolean

setNoIfBoolean

getNoLeadingZero

setNoLeadingZero

getNoSparseArray