JavaScriptType (Maven Service Documentation Generator Plugin 1.0.0 API)

java.lang.Object
- java.lang.Enum<JavaScriptType>
- - org.codehaus.mojo.servicedocgen.JavaScriptType

All Implemented Interfaces:

Serializable, Comparable<JavaScriptType>
```
public enum JavaScriptType
extends Enum<JavaScriptType>
```
Enum with types available in JavaScript.

Author:

hohwille

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY` An `array`.
`BOOLEAN` A `Boolean` flag.
`DATE` A `String`.
`INTEGER` A non-decimal `Number` (`Byte`, `Short`, `Integer`, or `Long`).
`NUMBER` A decimal `Number`.
`OBJECT` Any other data `Object`.
`STRING` A `String`.
`TYPE` A type as `String`.
`VOID` The `Void` type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getExample()`
`String`	`getName()`
`String`	`toString()`
`static JavaScriptType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JavaScriptType[]`	`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
  - NUMBER
```
public static final JavaScriptType NUMBER
```
    A decimal Number.
  - INTEGER
```
public static final JavaScriptType INTEGER
```
    A non-decimal Number (Byte, Short, Integer, or Long).
  - BOOLEAN
```
public static final JavaScriptType BOOLEAN
```
    A Boolean flag.
  - ARRAY
```
public static final JavaScriptType ARRAY
```
    An array.
  - STRING
```
public static final JavaScriptType STRING
```
    A String.
  - DATE
```
public static final JavaScriptType DATE
```
    A String.
  - TYPE
```
public static final JavaScriptType TYPE
```
    A type as String.
  - VOID
```
public static final JavaScriptType VOID
```
    The Void type.
  - OBJECT
```
public static final JavaScriptType OBJECT
```
    Any other data Object.
- Method Detail
  - values
```
public static JavaScriptType[] 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 (JavaScriptType c : JavaScriptType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JavaScriptType 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
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - getExample
```
public String getExample()
```
    Returns:
    
    the example
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<JavaScriptType>

Enum JavaScriptType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NUMBER

INTEGER

BOOLEAN

ARRAY

STRING

DATE

TYPE

VOID

OBJECT

Method Detail

values

valueOf

getName

getExample

toString