Environment (Syntax Compiler-Compiler 4.2.0 API)

java.lang.Object
- me.jaimegarza.syntax.env.Environment

```
public class Environment
extends Object
```
Examines the command line resources and encapsulates the resulting options in getter methods.
In addition to that it offers the private output, report and source fields to use as PrintWriters and BufferedReaders.

Field Summary

Fields
Modifier and Type	Field and Description
`AlgorithmicSupport`	`algorithm`
`FormattingPrintStream`	`bundle`
`FormattingPrintStream`	`include`
`LanguageSupport`	`language`
`Map<String,FormattingPrintStream>`	`lexerModes`
`FormattingPrintStream`	`output`
`FormattingPrintStream`	`report`
`BufferedReader`	`reportTemplate`
`HtmlWriter`	`reportWriter`
`BufferedReader`	`skeleton`
`BufferedReader`	`source`

Constructor Summary

Constructors
Constructor and Description
`Environment(String[] args)` Construct an environment with the given arguments
`Environment(String title, String[] args)` Construct an environment with the given arguments

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`error(int line, String msg, Object... args)` display an error
`String`	`formatFragment(String key, Object... objects)`
`Algorithm`	`getAlgorithmType()`
`String[]`	`getArgs()`
`File`	`getBundleFile()`
`String`	`getBundleName()`
`CommandLine`	`getCmd()`
`static Environment`	`getCurrentEnvironment()` Obtain the current environment for this thread
`Driver`	`getDriver()`
`String`	`getFragment(String key)`
`File`	`getIncludeFile()`
`int`	`getIndent()`
`Language`	`getLanguageEnum()`
`FormattingPrintStream`	`getLexerModePrintStream(String lexerMode)` Obtain an existing or new formatting print stream for a lexer mode
`Map<String,FormattingPrintStream>`	`getLexerModes()`
`Locale`	`getLocale()`
`int`	`getMargin()`
`File`	`getOutputFile()`
`String`	`getRelatedTitle()`
`File`	`getReportFile()`
`RuntimeData`	`getRuntimeData()`
`File`	`getSkeletonFile()`
`File`	`getSourceFile()`
`String`	`getTitle()`
`boolean`	`isDebug()`
`boolean`	`isEmitLine()`
`boolean`	`isExternalInclude()`
`boolean`	`isPacked()`
`boolean`	`isTokenizerMode()`
`boolean`	`isVerbose()`
`void`	`release()` close files
`static void`	`setCurrentEnvironment(Environment environment)` Once the environment is created by Syntax, it will be globally set for the given thread
`String`	`toString()`

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

Field Detail

source
```
public BufferedReader source
```

output
```
public FormattingPrintStream output
```

include
```
public FormattingPrintStream include
```

report
```
public FormattingPrintStream report
```

bundle
```
public FormattingPrintStream bundle
```

skeleton
```
public BufferedReader skeleton
```

reportTemplate
```
public BufferedReader reportTemplate
```

algorithm
```
public AlgorithmicSupport algorithm
```

language
```
public LanguageSupport language
```

reportWriter
```
public HtmlWriter reportWriter
```

lexerModes

public Map<String,FormattingPrintStream> lexerModes

Constructor Detail
- Environment
```
public Environment(String[] args)
```
  Construct an environment with the given arguments
  
  Parameters:
  
  args - command line arguments
- Environment
```
public Environment(String title,
                   String[] args)
```
  Construct an environment with the given arguments
  
  Parameters:
  
  title - title of the program
  
  args - command line arguments

Method Detail
- release
```
public void release()
```
  close files
- getFragment
```
public String getFragment(String key)
```
- formatFragment
```
public String formatFragment(String key,
                             Object... objects)
```
- getTitle
```
public String getTitle()
```
  Returns:
  
  the title
- error
```
public void error(int line,
                  String msg,
                  Object... args)
```
  display an error
  
  Parameters:
  
  line - is the source file line number
  
  msg - is the message for printf
  
  args - are the additional entries in the message
- getRelatedTitle
```
public String getRelatedTitle()
```
  Returns:
  
  the relatedTitle
- getArgs
```
public String[] getArgs()
```
  Returns:
  
  the args
- getCmd
```
public CommandLine getCmd()
```
  Returns:
  
  the cmd
- isTokenizerMode
```
public boolean isTokenizerMode()
```
  Returns:
  
  the language
- getLanguageEnum
```
public Language getLanguageEnum()
```
  Returns:
  
  the language
- isVerbose
```
public boolean isVerbose()
```
  Returns:
  
  the verbose
- isDebug
```
public boolean isDebug()
```
  Returns:
  
  the debug
- getAlgorithmType
```
public Algorithm getAlgorithmType()
```
  Returns:
  
  the algorithm
- getDriver
```
public Driver getDriver()
```
  Returns:
  
  the driver being used
- isEmitLine
```
public boolean isEmitLine()
```
  Returns:
  
  the emitLine
- getMargin
```
public int getMargin()
```
  Returns:
  
  the margin
- getIndent
```
public int getIndent()
```
  Returns:
  
  the indent
- isPacked
```
public boolean isPacked()
```
  Returns:
  
  the packed
- isExternalInclude
```
public boolean isExternalInclude()
```
  Returns:
  
  the externalInclude
- getSourceFile
```
public File getSourceFile()
```
  Returns:
  
  the sourceFile
- getOutputFile
```
public File getOutputFile()
```
  Returns:
  
  the outputFile
- getIncludeFile
```
public File getIncludeFile()
```
  Returns:
  
  the includeFile
- getReportFile
```
public File getReportFile()
```
  Returns:
  
  the reportFile
- getBundleFile
```
public File getBundleFile()
```
  Returns:
  
  the reportFile
- getSkeletonFile
```
public File getSkeletonFile()
```
  Returns:
  
  the reportFile
- getBundleName
```
public String getBundleName()
```
  Returns:
  
  the bundle name
- getLocale
```
public Locale getLocale()
```
  Returns:
  
  the locale
- getRuntimeData
```
public RuntimeData getRuntimeData()
```
  Returns:
  
  the runtimeData
- getLexerModePrintStream
```
public FormattingPrintStream getLexerModePrintStream(String lexerMode)
```
  Obtain an existing or new formatting print stream for a lexer mode
  
  Parameters:
  
  lexerMode - is the mode to use
  
  Returns:
  
  a new, or existing, formatting print stream
- getLexerModes
```
public Map<String,FormattingPrintStream> getLexerModes()
```
  Returns:
  
  the lexerModes
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
  
  See Also:
  
  Object.toString()
- setCurrentEnvironment
```
public static void setCurrentEnvironment(Environment environment)
```
  Once the environment is created by Syntax, it will be globally set for the given thread
  
  Parameters:
  
  environment - is the syntax environment.
- getCurrentEnvironment
```
public static Environment getCurrentEnvironment()
```
  Obtain the current environment for this thread
  
  Returns:
  
  the current global environment for this thread

Class Environment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

source

output

include

report

bundle

skeleton

reportTemplate

algorithm

language

reportWriter

lexerModes

Constructor Detail

Environment

Environment

Method Detail

release

getFragment

formatFragment

getTitle

error

getRelatedTitle

getArgs

getCmd

isTokenizerMode

getLanguageEnum

isVerbose

isDebug

getAlgorithmType

getDriver

isEmitLine

getMargin

getIndent

isPacked

isExternalInclude

getSourceFile

getOutputFile

getIncludeFile

getReportFile

getBundleFile

getSkeletonFile

getBundleName

getLocale

getRuntimeData

getLexerModePrintStream

getLexerModes

toString

setCurrentEnvironment

getCurrentEnvironment