com.googlecode.jslint4java
Enum Option

java.lang.Object
  extended by java.lang.Enum<Option>
      extended by com.googlecode.jslint4java.Option
All Implemented Interfaces:
Serializable, Comparable<Option>

public enum Option
extends Enum<Option>

All available options for tuning the behaviour of JSLint. TODO Add a "Handler" class for each type, which knows whether it needs an arg, how to parse it, etc.

Author:
dom

Enum Constant Summary
ADSAFE
          If adsafe should be enforced
BITWISE
          If bitwise operators should not be allowed
BROWSER
          If the standard browser globals should be predefined
CAP
          If upper case html should be allowed
CSS
          If css workarounds should be tolerated
DEBUG
          If debugger statements should be allowed
DEVEL
          If logging should be allowed (console, alert, etc.)
EQEQEQ
          If === should be required
ES5
          If es5 syntax should be allowed
EVIL
          If eval should be allowed
FORIN
          If for in statements must filter
FRAGMENT
          If html fragments should be allowed
IMMED
          If immediate invocations must be wrapped in parens
INDENT
          The number of spaces used for indentation (default is 4)
LAXBREAK
          If line breaks should not be checked
MAXERR
          The maximum number of warnings reported (default is 50)
MAXLEN
          Maximum line length
NEWCAP
          If constructor names must be capitalized
NOMEN
          If names should be checked
ON
          If html event handlers should be allowed
ONEVAR
          If only one var statement per function should be allowed
PASSFAIL
          If the scan should stop on first error
PLUSPLUS
          If increment/decrement should not be allowed
PREDEF
          The names of predefined global variables.
REGEXP
          If the .
RHINO
          If the rhino environment globals should be predefined
SAFE
          If use of some browser features should be restricted
STRICT
          Require the "use strict"; pragma
SUB
          If all forms of subscript notation are tolerated
UNDEF
          If variables should be declared before used
WHITE
          If strict whitespace rules apply
WIDGET
          If the yahoo widgets globals should be predefined
WINDOWS
          If ms windows-specigic globals should be predefined
 
Method Summary
 String getDescription()
          Return a description of what this option affects.
 String getLowerName()
          Return the lowercase name of this option.
 Class<?> getType()
          What type does the value of this option have?
static int maximumNameLength()
          Calculate the maximum length of all of the Option names.
 String toString()
          Show this option and its description.
static Option valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Option[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ADSAFE

public static final Option ADSAFE
If adsafe should be enforced


BITWISE

public static final Option BITWISE
If bitwise operators should not be allowed


BROWSER

public static final Option BROWSER
If the standard browser globals should be predefined


CAP

public static final Option CAP
If upper case html should be allowed


CSS

public static final Option CSS
If css workarounds should be tolerated


DEBUG

public static final Option DEBUG
If debugger statements should be allowed


DEVEL

public static final Option DEVEL
If logging should be allowed (console, alert, etc.)


EQEQEQ

public static final Option EQEQEQ
If === should be required


ES5

public static final Option ES5
If es5 syntax should be allowed


EVIL

public static final Option EVIL
If eval should be allowed


FORIN

public static final Option FORIN
If for in statements must filter


FRAGMENT

public static final Option FRAGMENT
If html fragments should be allowed


IMMED

public static final Option IMMED
If immediate invocations must be wrapped in parens


INDENT

public static final Option INDENT
The number of spaces used for indentation (default is 4)


LAXBREAK

public static final Option LAXBREAK
If line breaks should not be checked


MAXERR

public static final Option MAXERR
The maximum number of warnings reported (default is 50)


MAXLEN

public static final Option MAXLEN
Maximum line length


NEWCAP

public static final Option NEWCAP
If constructor names must be capitalized


NOMEN

public static final Option NOMEN
If names should be checked


ON

public static final Option ON
If html event handlers should be allowed


ONEVAR

public static final Option ONEVAR
If only one var statement per function should be allowed


PASSFAIL

public static final Option PASSFAIL
If the scan should stop on first error


PLUSPLUS

public static final Option PLUSPLUS
If increment/decrement should not be allowed


PREDEF

public static final Option PREDEF
The names of predefined global variables.


REGEXP

public static final Option REGEXP
If the . should not be allowed in regexp literals


RHINO

public static final Option RHINO
If the rhino environment globals should be predefined


SAFE

public static final Option SAFE
If use of some browser features should be restricted


STRICT

public static final Option STRICT
Require the "use strict"; pragma


SUB

public static final Option SUB
If all forms of subscript notation are tolerated


UNDEF

public static final Option UNDEF
If variables should be declared before used


WHITE

public static final Option WHITE
If strict whitespace rules apply


WIDGET

public static final Option WIDGET
If the yahoo widgets globals should be predefined


WINDOWS

public static final Option WINDOWS
If ms windows-specigic globals should be predefined

Method Detail

values

public static final Option[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Option c : Option.values())
        System.out.println(c);

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

valueOf

public static Option 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

getDescription

public String getDescription()
Return a description of what this option affects.


getLowerName

public String getLowerName()
Return the lowercase name of this option.


getType

public Class<?> getType()
What type does the value of this option have?


maximumNameLength

public static int maximumNameLength()
Calculate the maximum length of all of the Option names.

Returns:
the length of the largest name.

toString

public String toString()
Show this option and its description.

Overrides:
toString in class Enum<Option>


Copyright © 2007-2011. All Rights Reserved.