ShellToken (jclouds 1.5.5 API)

java.lang.Object
- java.lang.Enum<ShellToken>
- - org.jclouds.scriptbuilder.domain.ShellToken

All Implemented Interfaces:

Serializable, Comparable<ShellToken>
```
public enum ShellToken
extends Enum<ShellToken>
```
Constants used in shell scripting.

Author:

Adrian Cole

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGS`
`BEGIN_FUNCTIONS`
`BEGIN_SCRIPT`
`CD`
`CLOSE_FD`
`END_FUNCTIONS`
`END_SCRIPT`
`ESCVAR`
`EXIT`
`EXPORT`
`FNCE` End the function.
`FNCL` Left hand side of the function declaration directly before the name of the function.
`FNCR` Right hand side of the function declaration directly after the name of the function.
`FS`
`LF`
`LIBRARY_PATH_VARIABLE`
`MD`
`PS`
`REM`
`RETURN`
`RM`
`ROOT`
`SH`
`SOURCE`
`TMP`
`UID`
`VARL`
`VARR`
`VQ` If variable values need to be quoted when they include spaces, this will contain quotation mark

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`to(OsFamily family)`
`static Map<String,String>`	`tokenValueMap(OsFamily family)`
`static ShellToken`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ShellToken[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FS
```
public static final ShellToken FS
```

RM
```
public static final ShellToken RM
```

CD
```
public static final ShellToken CD
```

TMP
```
public static final ShellToken TMP
```

UID
```
public static final ShellToken UID
```

ROOT
```
public static final ShellToken ROOT
```

CLOSE_FD

public static final ShellToken CLOSE_FD

PS
```
public static final ShellToken PS
```

MD
```
public static final ShellToken MD
```

ESCVAR
```
public static final ShellToken ESCVAR
```

VQ
```
public static final ShellToken VQ
```
If variable values need to be quoted when they include spaces, this will contain quotation mark

FNCL
```
public static final ShellToken FNCL
```
Left hand side of the function declaration directly before the name of the function.

FNCR
```
public static final ShellToken FNCR
```
Right hand side of the function declaration directly after the name of the function. opens the code block

FNCE
```
public static final ShellToken FNCE
```
End the function. exits successfully and closes the code block.

BEGIN_SCRIPT

public static final ShellToken BEGIN_SCRIPT

END_SCRIPT

public static final ShellToken END_SCRIPT

BEGIN_FUNCTIONS

public static final ShellToken BEGIN_FUNCTIONS

EXIT
```
public static final ShellToken EXIT
```

END_FUNCTIONS

public static final ShellToken END_FUNCTIONS

EXPORT
```
public static final ShellToken EXPORT
```

LF
```
public static final ShellToken LF
```

SH
```
public static final ShellToken SH
```

SOURCE
```
public static final ShellToken SOURCE
```

REM
```
public static final ShellToken REM
```

RETURN
```
public static final ShellToken RETURN
```

ARGS
```
public static final ShellToken ARGS
```

VARL
```
public static final ShellToken VARL
```

VARR
```
public static final ShellToken VARR
```

LIBRARY_PATH_VARIABLE

public static final ShellToken LIBRARY_PATH_VARIABLE

Method Detail
- values
```
public static ShellToken[] 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 (ShellToken c : ShellToken.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static ShellToken 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
- tokenValueMap
```
public static Map<String,String> tokenValueMap(OsFamily family)
```
- to
```
public String to(OsFamily family)
```

Enum ShellToken

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FS

RM

CD

TMP

UID

ROOT

CLOSE_FD

PS

MD

ESCVAR

VQ

FNCL

FNCR

FNCE

BEGIN_SCRIPT

END_SCRIPT

BEGIN_FUNCTIONS

EXIT

END_FUNCTIONS

EXPORT

LF

SH

SOURCE

REM

RETURN

ARGS

VARL

VARR

LIBRARY_PATH_VARIABLE

Method Detail

values

valueOf

tokenValueMap

to