Settings

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

SettingsImpl
```
public interface Settings
extends java.lang.Cloneable
```
Object thats define all tunable settings used by Console

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`boolean`	`doExportUsesSystemEnvironment()` Is load environment system?
`boolean`	`doPersistAlias()` Is alias persisted
`boolean`	`doPersistExport()` Is aesh persisting variables at shutdown
`boolean`	`doReadInputrc()` Do aesh read inputrc during init
`AeshContext`	`getAeshContext()` Get aesh context
`java.io.File`	`getAliasFile()` Location of alias file
`java.lang.String`	`getBellStyle()` Get bell style NOTE: Not used yet
`EditMode`	`getEditMode()` Get current edit mode
`java.lang.String`	`getExecuteAtStart()`
`Resource`	`getExecuteFileAtStart()`
`java.io.File`	`getExportFile()` Get the export file Defaults to ~/.aesh_export
`java.io.File`	`getHistoryFile()` Get file where history is stored
`FileAccessPermission`	`getHistoryFilePermission()` Get history file access permission, this is used when write to history file.
`int`	`getHistorySize()` Get history size
`java.io.File`	`getInputrc()` Get inputrc file location
`java.io.InputStream`	`getInputStream()` Get input stream
`InterruptHook`	`getInterruptHook()` Get interrupt hook
`java.lang.String`	`getLogFile()` Get location of log file
`Mode`	`getMode()` Get the current Mode.
`java.lang.String`	`getName()` Get the name of the cli Default is "aesh"
`KeyOperationManager`	`getOperationManager()` Get KeyOperationManager
`QuitHandler`	`getQuitHandler()` Get quit handler
`Resource`	`getResource()`
`java.io.PrintStream`	`getStdErr()` Get standard error stream
`java.io.PrintStream`	`getStdOut()` Get standard output stream
`Terminal`	`getTerminal()` Get current terminal
`boolean`	`hasInterruptHook()` Is an interrupt hook defined
`boolean`	`isAliasEnabled()` Is alias enabled
`boolean`	`isAnsiConsole()` If the current console is an ANSI console
`boolean`	`isCompletionDisabled()` Is completion disabled
`boolean`	`isExportEnabled()` Are export enabled?
`boolean`	`isHistoryDisabled()` Is history disabled
`boolean`	`isHistoryPersistent()` Is history persisted during shutdown
`boolean`	`isLogging()` Are we logging
`boolean`	`isManEnabled()` Is the man command enabled (currently only for AeshConsole)
`boolean`	`isOperatorParserEnabled()` Is operator parser enabled
`void`	`resetEditMode()` Reset edit mode
`void`	`setExecuteAtStart(java.lang.String execute)`
`void`	`setExecuteFileAtStart(Resource executeFileAtStart)`
`void`	`setExportUsesSystemEnvironment(boolean isLoad)` Aesh load environment system.
`void`	`setPersistExport(boolean persist)` Should aesh persist export variables at shutdown
`void`	`setResource(Resource resource)` Specify
`void`	`switchMode()` Switch from Emacs to Vi mode (or back)

- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name of the cli Default is "aesh"
  - getMode
```
Mode getMode()
```
    Get the current Mode. Default mode is Emacs
  - getEditMode
```
EditMode getEditMode()
```
    Get current edit mode
  - resetEditMode
```
void resetEditMode()
```
    Reset edit mode
  - getOperationManager
```
KeyOperationManager getOperationManager()
```
    Get KeyOperationManager
  - getHistoryFile
```
java.io.File getHistoryFile()
```
    Get file where history is stored
  - getHistoryFilePermission
```
FileAccessPermission getHistoryFilePermission()
```
    Get history file access permission, this is used when write to history file. null means default file permission revealed by system.
  - getHistorySize
```
int getHistorySize()
```
    Get history size
  - getBellStyle
```
java.lang.String getBellStyle()
```
    Get bell style NOTE: Not used yet
  - isAnsiConsole
```
boolean isAnsiConsole()
```
    If the current console is an ANSI console
  - getInputStream
```
java.io.InputStream getInputStream()
```
    Get input stream
  - getStdOut
```
java.io.PrintStream getStdOut()
```
    Get standard output stream
  - getStdErr
```
java.io.PrintStream getStdErr()
```
    Get standard error stream
  - getTerminal
```
Terminal getTerminal()
```
    Get current terminal
  - getInputrc
```
java.io.File getInputrc()
```
    Get inputrc file location
  - isLogging
```
boolean isLogging()
```
    Are we logging
  - isCompletionDisabled
```
boolean isCompletionDisabled()
```
    Is completion disabled
  - getLogFile
```
java.lang.String getLogFile()
```
    Get location of log file
  - doReadInputrc
```
boolean doReadInputrc()
```
    Do aesh read inputrc during init
  - isHistoryDisabled
```
boolean isHistoryDisabled()
```
    Is history disabled
  - isHistoryPersistent
```
boolean isHistoryPersistent()
```
    Is history persisted during shutdown
  - getAliasFile
```
java.io.File getAliasFile()
```
    Location of alias file
  - isAliasEnabled
```
boolean isAliasEnabled()
```
    Is alias enabled
  - doPersistAlias
```
boolean doPersistAlias()
```
    Is alias persisted
  - getQuitHandler
```
QuitHandler getQuitHandler()
```
    Get quit handler
  - hasInterruptHook
```
boolean hasInterruptHook()
```
    Is an interrupt hook defined
  - getInterruptHook
```
InterruptHook getInterruptHook()
```
    Get interrupt hook
  - isOperatorParserEnabled
```
boolean isOperatorParserEnabled()
```
    Is operator parser enabled
  - switchMode
```
void switchMode()
```
    Switch from Emacs to Vi mode (or back)
  - isManEnabled
```
boolean isManEnabled()
```
    Is the man command enabled (currently only for AeshConsole)
  - getAeshContext
```
AeshContext getAeshContext()
```
    Get aesh context
  - getExportFile
```
java.io.File getExportFile()
```
    Get the export file Defaults to ~/.aesh_export
  - isExportEnabled
```
boolean isExportEnabled()
```
    Are export enabled?
  - setPersistExport
```
void setPersistExport(boolean persist)
```
    Should aesh persist export variables at shutdown
  - doPersistExport
```
boolean doPersistExport()
```
    Is aesh persisting variables at shutdown
  - setExportUsesSystemEnvironment
```
void setExportUsesSystemEnvironment(boolean isLoad)
```
    Aesh load environment system.
  - doExportUsesSystemEnvironment
```
boolean doExportUsesSystemEnvironment()
```
    Is load environment system?
  - setResource
```
void setResource(Resource resource)
```
    Specify
    
    Parameters:
    
    resource -
  - setExecuteAtStart
```
void setExecuteAtStart(java.lang.String execute)
```
    Parameters:
    
    execute - specify a string that will be pushed to the input stream at start
  - getExecuteAtStart
```
java.lang.String getExecuteAtStart()
```
    Returns:
    
    execute at start string
  - setExecuteFileAtStart
```
void setExecuteFileAtStart(Resource executeFileAtStart)
```
    Parameters:
    
    executeFileAtStart - file that will be read, parsed and executed at start
  - getExecuteFileAtStart
```
Resource getExecuteFileAtStart()
```
    Returns:
    
    execute file at start
  - getResource
```
Resource getResource()
```
  - clone
```
java.lang.Object clone()
```

Interface Settings

Method Summary

Method Detail

getName

getMode

getEditMode

resetEditMode

getOperationManager

getHistoryFile

getHistoryFilePermission

getHistorySize

getBellStyle

isAnsiConsole

getInputStream

getStdOut

getStdErr

getTerminal

getInputrc

isLogging

isCompletionDisabled

getLogFile

doReadInputrc

isHistoryDisabled

isHistoryPersistent

getAliasFile

isAliasEnabled

doPersistAlias

getQuitHandler

hasInterruptHook

getInterruptHook

isOperatorParserEnabled

switchMode

isManEnabled

getAeshContext

getExportFile

isExportEnabled

setPersistExport

doPersistExport

setExportUsesSystemEnvironment

doExportUsesSystemEnvironment

setResource

setExecuteAtStart

getExecuteAtStart

setExecuteFileAtStart

getExecuteFileAtStart

getResource

clone