SettingsImpl

java.lang.Object
- org.jboss.aesh.console.settings.SettingsImpl

All Implemented Interfaces:

java.lang.Cloneable, Settings
```
public class SettingsImpl
extends java.lang.Object
implements Settings
```
Settings object that is parsed when Console is initialized.

Field Summary

Fields
Modifier and Type	Field and Description
`private AeshContext`	`aeshContext`
`private boolean`	`aliasEnabled`
`private java.io.File`	`aliasFile`
`private boolean`	`ansiConsole`
`private java.lang.String`	`bellStyle`
`private boolean`	`disableCompletion`
`private Mode`	`editMode`
`private boolean`	`enableOperatorParser`
`private java.lang.String`	`execute`
`private Resource`	`executeFileAtStart`
`private boolean`	`exportEnabled`
`private java.io.File`	`exportFile`
`private boolean`	`exportUsesSystemEnvironment`
`private boolean`	`historyDisabled`
`private java.io.File`	`historyFile`
`private FileAccessPermission`	`historyFilePermission`
`private boolean`	`historyPersistent`
`private int`	`historySize`
`private java.io.File`	`inputrc`
`private java.io.InputStream`	`inputStream`
`private InterruptHook`	`interruptHook`
`private boolean`	`isLogging`
`private java.lang.String`	`logFile`
`private boolean`	`manEnabled`
`private java.lang.String`	`name`
`private KeyOperationManager`	`operationManager`
`private boolean`	`persistAlias`
`private boolean`	`persistExport`
`private QuitHandler`	`quitHandler`
`private boolean`	`readInputrc`
`private Resource`	`resource`
`private java.io.PrintStream`	`stdErr`
`private java.io.PrintStream`	`stdOut`
`private Terminal`	`terminal`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SettingsImpl()

protected SettingsImpl(Settings baseSettings)

Constructors
Modifier	Constructor and Description
`protected`	`SettingsImpl()`
`protected`	`SettingsImpl(Settings baseSettings)`

Method Summary

All Methods Instance Methods Concrete 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()` Should we read config from inputrc Set to true by default
`void`	`enableOperatorParser(boolean enable)`
`AeshContext`	`getAeshContext()` Get aesh context
`java.io.File`	`getAliasFile()` Location of alias file
`java.lang.String`	`getBellStyle()` By default, bell style is noisy NOTE: Not implemented yet
`EditMode`	`getEditMode()` Get EditMode based on os and mode
`java.lang.String`	`getExecuteAtStart()`
`Resource`	`getExecuteFileAtStart()`
`java.io.File`	`getExportFile()` Get the export file Defaults to ~/.aesh_export
`java.io.File`	`getHistoryFile()` If not set the history file will be: $HOME/.aesh_history
`FileAccessPermission`	`getHistoryFilePermission()` Get history file access permission, this is used when write to history file.
`int`	`getHistorySize()` By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
`java.io.File`	`getInputrc()` Get the inputrc file, if not set it defaults to: System.getProperty("user.home")+Config.getPathSeparator()+".inputrc"
`java.io.InputStream`	`getInputStream()` If not set, System.in will be used
`InterruptHook`	`getInterruptHook()` Get interrupt hook
`java.lang.String`	`getLogFile()` Get log file
`Mode`	`getMode()` Either Emacs or Vi mode.
`java.lang.String`	`getName()` Get the name of the cli
`KeyOperationManager`	`getOperationManager()` Get KeyOperationManager
`QuitHandler`	`getQuitHandler()` Get quit handler
`Resource`	`getResource()`
`java.io.PrintStream`	`getStdErr()` If not set System.out is used
`java.io.PrintStream`	`getStdOut()` If not set System.out is used
`Terminal`	`getTerminal()` Use the specified terminal implementation If not set, aesh will try to use the best suited one
`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? Set to false by default
`boolean`	`isExportEnabled()` Are export enabled?
`boolean`	`isHistoryDisabled()` Is history disabled Set to true to disable history
`boolean`	`isHistoryPersistent()` Is the history list persisted to file.
`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`	`resetToDefaults()`
`void`	`setAeshContext(AeshContext aeshContext)`
`void`	`setAliasEnabled(boolean enabled)`
`void`	`setAliasFile(java.io.File file)`
`void`	`setAnsiConsole(boolean ansiConsole)` Possible to override the type of console
`void`	`setBellStyle(java.lang.String bellStyle)`
`void`	`setDisableCompletion(boolean disableCompletion)` Set to true do disable completion Set to false by default
`void`	`setExecuteAtStart(java.lang.String execute)`
`void`	`setExecuteFileAtStart(Resource executeFileAtStart)`
`void`	`setExportEnabled(boolean exportEnabled)`
`void`	`setExportFile(java.io.File exportFile)`
`void`	`setExportUsesSystemEnvironment(boolean isLoad)` Aesh load environment system.
`void`	`setHistoryDisabled(boolean historyDisabled)` Is history disabled Set to true to disable history
`void`	`setHistoryFile(java.io.File historyFile)`
`void`	`setHistoryFilePermission(FileAccessPermission historyFilePermission)`
`void`	`setHistoryPersistent(boolean historyPersistent)` Is the history list persisted to file.
`void`	`setHistorySize(int historySize)` By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
`void`	`setInputrc(java.io.File inputrc)`
`void`	`setInputStream(java.io.InputStream inputStream)` Set where input is coming from
`void`	`setInterruptHook(InterruptHook hook)`
`void`	`setLogFile(java.lang.String logFile)` Specify a log file
`void`	`setLogging(boolean logging)` Set logging, by default set to true
`void`	`setManEnabled(boolean enabled)`
`void`	`setMode(Mode editMode)`
`void`	`setName(java.lang.String name)` Set the name of the cli
`void`	`setPersistAlias(boolean persist)`
`void`	`setPersistExport(boolean persistExport)` Should aesh persist export variables at shutdown
`void`	`setQuitHandler(QuitHandler qh)`
`void`	`setReadInputrc(boolean readInputrc)` Specify if we should read config from inputrc Set to true by default
`void`	`setResource(Resource resource)` Specify
`void`	`setStdErr(java.io.PrintStream stdErr)` Set where output should go to
`void`	`setStdOut(java.io.PrintStream stdOut)` Set where output should go to
`void`	`setTerminal(Terminal terminal)` Specify which terminal impl to use
`void`	`switchMode()` Switch from Emacs to Vi mode (or back)

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

- Field Detail
  - name
```
private java.lang.String name
```
  - editMode
```
private Mode editMode
```
  - historyFile
```
private java.io.File historyFile
```
  - historyFilePermission
```
private FileAccessPermission historyFilePermission
```
  - historySize
```
private int historySize
```
  - historyDisabled
```
private boolean historyDisabled
```
  - historyPersistent
```
private boolean historyPersistent
```
  - bellStyle
```
private java.lang.String bellStyle
```
  - ansiConsole
```
private boolean ansiConsole
```
  - inputStream
```
private java.io.InputStream inputStream
```
  - stdOut
```
private java.io.PrintStream stdOut
```
  - stdErr
```
private java.io.PrintStream stdErr
```
  - terminal
```
private Terminal terminal
```
  - readInputrc
```
private boolean readInputrc
```
  - inputrc
```
private java.io.File inputrc
```
  - isLogging
```
private boolean isLogging
```
  - logFile
```
private java.lang.String logFile
```
  - disableCompletion
```
private boolean disableCompletion
```
  - quitHandler
```
private QuitHandler quitHandler
```
  - operationManager
```
private KeyOperationManager operationManager
```
  - aliasFile
```
private java.io.File aliasFile
```
  - aliasEnabled
```
private boolean aliasEnabled
```
  - persistAlias
```
private boolean persistAlias
```
  - interruptHook
```
private InterruptHook interruptHook
```
  - enableOperatorParser
```
private boolean enableOperatorParser
```
  - manEnabled
```
private boolean manEnabled
```
  - aeshContext
```
private AeshContext aeshContext
```
  - exportEnabled
```
private boolean exportEnabled
```
  - exportFile
```
private java.io.File exportFile
```
  - persistExport
```
private boolean persistExport
```
  - exportUsesSystemEnvironment
```
private boolean exportUsesSystemEnvironment
```
  - resource
```
private Resource resource
```
  - execute
```
private java.lang.String execute
```
  - executeFileAtStart
```
private Resource executeFileAtStart
```
- Constructor Detail
  - SettingsImpl
```
protected SettingsImpl()
```
  - SettingsImpl
```
protected SettingsImpl(Settings baseSettings)
```
- Method Detail
  - resetToDefaults
```
public void resetToDefaults()
```
  - setName
```
public void setName(java.lang.String name)
```
    Set the name of the cli
    
    Parameters:
    
    name - name
  - getName
```
public java.lang.String getName()
```
    Get the name of the cli
    
    Specified by:
    
    getName in interface Settings
    
    Returns:
    
    default is aesh
  - getMode
```
public Mode getMode()
```
    Either Emacs or Vi mode. Emacs is default if not set
    
    Specified by:
    
    getMode in interface Settings
    
    Returns:
    
    editing mode
  - setMode
```
public void setMode(Mode editMode)
```
  - getEditMode
```
public EditMode getEditMode()
```
    Get EditMode based on os and mode
    
    Specified by:
    
    getEditMode in interface Settings
    
    Returns:
    
    edit mode
  - resetEditMode
```
public void resetEditMode()
```
    Description copied from interface: Settings
    
    Reset edit mode
    
    Specified by:
    
    resetEditMode in interface Settings
  - getOperationManager
```
public KeyOperationManager getOperationManager()
```
    Description copied from interface: Settings
    
    Get KeyOperationManager
    
    Specified by:
    
    getOperationManager in interface Settings
  - getHistoryFilePermission
```
public FileAccessPermission getHistoryFilePermission()
```
    Description copied from interface: Settings
    
    Get history file access permission, this is used when write to history file. null means default file permission revealed by system.
    
    Specified by:
    
    getHistoryFilePermission in interface Settings
    
    Returns:
    
    the historyFilePermission
  - setHistoryFilePermission
```
public void setHistoryFilePermission(FileAccessPermission historyFilePermission)
```
    Parameters:
    
    historyFilePermission - the historyFilePermission to set
  - getHistoryFile
```
public java.io.File getHistoryFile()
```
    If not set the history file will be: $HOME/.aesh_history
    
    Specified by:
    
    getHistoryFile in interface Settings
    
    Returns:
    
    history file
  - setHistoryFile
```
public void setHistoryFile(java.io.File historyFile)
```
  - getHistorySize
```
public int getHistorySize()
```
    By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
    
    Specified by:
    
    getHistorySize in interface Settings
    
    Returns:
    
    size
  - setHistorySize
```
public void setHistorySize(int historySize)
```
    By default history size is 500 If its set to -1 the size is unlimited (Integer.MAX_VALUE)
    
    Parameters:
    
    historySize - size
  - getBellStyle
```
public java.lang.String getBellStyle()
```
    By default, bell style is noisy NOTE: Not implemented yet
    
    Specified by:
    
    getBellStyle in interface Settings
    
    Returns:
    
    bell style
  - setBellStyle
```
public void setBellStyle(java.lang.String bellStyle)
```
  - isAnsiConsole
```
public boolean isAnsiConsole()
```
    Description copied from interface: Settings
    
    If the current console is an ANSI console
    
    Specified by:
    
    isAnsiConsole in interface Settings
    
    Returns:
    
    true if its an ansi console
  - setAnsiConsole
```
public void setAnsiConsole(boolean ansiConsole)
```
    Possible to override the type of console
    
    Parameters:
    
    ansiConsole - is it an ansi compatible console?
  - getInputStream
```
public java.io.InputStream getInputStream()
```
    If not set, System.in will be used
    
    Specified by:
    
    getInputStream in interface Settings
    
    Returns:
    
    input
  - setInputStream
```
public void setInputStream(java.io.InputStream inputStream)
```
    Set where input is coming from
    
    Parameters:
    
    inputStream - input
  - getStdOut
```
public java.io.PrintStream getStdOut()
```
    If not set System.out is used
    
    Specified by:
    
    getStdOut in interface Settings
    
    Returns:
    
    out
  - setStdOut
```
public void setStdOut(java.io.PrintStream stdOut)
```
    Set where output should go to
    
    Parameters:
    
    stdOut - output
  - getStdErr
```
public java.io.PrintStream getStdErr()
```
    If not set System.out is used
    
    Specified by:
    
    getStdErr in interface Settings
    
    Returns:
    
    out
  - setStdErr
```
public void setStdErr(java.io.PrintStream stdErr)
```
    Set where output should go to
    
    Parameters:
    
    stdErr - output
  - getTerminal
```
public Terminal getTerminal()
```
    Use the specified terminal implementation If not set, aesh will try to use the best suited one
    
    Specified by:
    
    getTerminal in interface Settings
    
    Returns:
    
    terminal
  - setTerminal
```
public void setTerminal(Terminal terminal)
```
    Specify which terminal impl to use
    
    Parameters:
    
    terminal - term
  - getInputrc
```
public java.io.File getInputrc()
```
    Get the inputrc file, if not set it defaults to: System.getProperty("user.home")+Config.getPathSeparator()+".inputrc"
    
    Specified by:
    
    getInputrc in interface Settings
    
    Returns:
    
    inputrc
  - setInputrc
```
public void setInputrc(java.io.File inputrc)
```
  - isLogging
```
public boolean isLogging()
```
    Are we logging?
    
    Specified by:
    
    isLogging in interface Settings
    
    Returns:
    
    logging
  - setLogging
```
public void setLogging(boolean logging)
```
    Set logging, by default set to true
    
    Parameters:
    
    logging - do log
  - isCompletionDisabled
```
public boolean isCompletionDisabled()
```
    Is completion disabled? Set to false by default
    
    Specified by:
    
    isCompletionDisabled in interface Settings
    
    Returns:
    
    dis completion
  - setDisableCompletion
```
public void setDisableCompletion(boolean disableCompletion)
```
    Set to true do disable completion Set to false by default
    
    Parameters:
    
    disableCompletion - dis
  - getLogFile
```
public java.lang.String getLogFile()
```
    Get log file
    
    Specified by:
    
    getLogFile in interface Settings
    
    Returns:
    
    log file
  - setLogFile
```
public void setLogFile(java.lang.String logFile)
```
    Specify a log file
    
    Parameters:
    
    logFile - file
  - doReadInputrc
```
public boolean doReadInputrc()
```
    Should we read config from inputrc Set to true by default
    
    Specified by:
    
    doReadInputrc in interface Settings
    
    Returns:
    
    do we?
  - setReadInputrc
```
public void setReadInputrc(boolean readInputrc)
```
    Specify if we should read config from inputrc Set to true by default
    
    Parameters:
    
    readInputrc - specify
  - isHistoryDisabled
```
public boolean isHistoryDisabled()
```
    Is history disabled Set to true to disable history
    
    Specified by:
    
    isHistoryDisabled in interface Settings
    
    Returns:
    
    historyDisabled
  - setHistoryDisabled
```
public void setHistoryDisabled(boolean historyDisabled)
```
    Is history disabled Set to true to disable history
    
    Parameters:
    
    historyDisabled - history
  - isHistoryPersistent
```
public boolean isHistoryPersistent()
```
    Is the history list persisted to file. Set to true by default
    
    Specified by:
    
    isHistoryPersistent in interface Settings
    
    Returns:
    
    is history persistent
  - setHistoryPersistent
```
public void setHistoryPersistent(boolean historyPersistent)
```
    Is the history list persisted to file. Set to true by default
    
    Parameters:
    
    historyPersistent - history
  - setAliasFile
```
public void setAliasFile(java.io.File file)
```
  - getAliasFile
```
public java.io.File getAliasFile()
```
    Description copied from interface: Settings
    
    Location of alias file
    
    Specified by:
    
    getAliasFile in interface Settings
  - isAliasEnabled
```
public boolean isAliasEnabled()
```
    Description copied from interface: Settings
    
    Is alias enabled
    
    Specified by:
    
    isAliasEnabled in interface Settings
  - setAliasEnabled
```
public void setAliasEnabled(boolean enabled)
```
  - setPersistAlias
```
public void setPersistAlias(boolean persist)
```
  - doPersistAlias
```
public boolean doPersistAlias()
```
    Description copied from interface: Settings
    
    Is alias persisted
    
    Specified by:
    
    doPersistAlias in interface Settings
  - setQuitHandler
```
public void setQuitHandler(QuitHandler qh)
```
  - getQuitHandler
```
public QuitHandler getQuitHandler()
```
    Description copied from interface: Settings
    
    Get quit handler
    
    Specified by:
    
    getQuitHandler in interface Settings
  - setInterruptHook
```
public void setInterruptHook(InterruptHook hook)
```
  - hasInterruptHook
```
public boolean hasInterruptHook()
```
    Description copied from interface: Settings
    
    Is an interrupt hook defined
    
    Specified by:
    
    hasInterruptHook in interface Settings
  - getInterruptHook
```
public InterruptHook getInterruptHook()
```
    Description copied from interface: Settings
    
    Get interrupt hook
    
    Specified by:
    
    getInterruptHook in interface Settings
  - enableOperatorParser
```
public void enableOperatorParser(boolean enable)
```
  - isOperatorParserEnabled
```
public boolean isOperatorParserEnabled()
```
    Description copied from interface: Settings
    
    Is operator parser enabled
    
    Specified by:
    
    isOperatorParserEnabled in interface Settings
  - switchMode
```
public void switchMode()
```
    Description copied from interface: Settings
    
    Switch from Emacs to Vi mode (or back)
    
    Specified by:
    
    switchMode in interface Settings
  - isManEnabled
```
public boolean isManEnabled()
```
    Description copied from interface: Settings
    
    Is the man command enabled (currently only for AeshConsole)
    
    Specified by:
    
    isManEnabled in interface Settings
  - setManEnabled
```
public void setManEnabled(boolean enabled)
```
  - getAeshContext
```
public AeshContext getAeshContext()
```
    Description copied from interface: Settings
    
    Get aesh context
    
    Specified by:
    
    getAeshContext in interface Settings
  - setAeshContext
```
public void setAeshContext(AeshContext aeshContext)
```
  - getExportFile
```
public java.io.File getExportFile()
```
    Description copied from interface: Settings
    
    Get the export file Defaults to ~/.aesh_export
    
    Specified by:
    
    getExportFile in interface Settings
  - setExportFile
```
public void setExportFile(java.io.File exportFile)
```
  - isExportEnabled
```
public boolean isExportEnabled()
```
    Description copied from interface: Settings
    
    Are export enabled?
    
    Specified by:
    
    isExportEnabled in interface Settings
  - setExportEnabled
```
public void setExportEnabled(boolean exportEnabled)
```
  - setPersistExport
```
public void setPersistExport(boolean persistExport)
```
    Description copied from interface: Settings
    
    Should aesh persist export variables at shutdown
    
    Specified by:
    
    setPersistExport in interface Settings
  - doPersistExport
```
public boolean doPersistExport()
```
    Description copied from interface: Settings
    
    Is aesh persisting variables at shutdown
    
    Specified by:
    
    doPersistExport in interface Settings
  - setExportUsesSystemEnvironment
```
public void setExportUsesSystemEnvironment(boolean isLoad)
```
    Description copied from interface: Settings
    
    Aesh load environment system.
    
    Specified by:
    
    setExportUsesSystemEnvironment in interface Settings
  - doExportUsesSystemEnvironment
```
public boolean doExportUsesSystemEnvironment()
```
    Description copied from interface: Settings
    
    Is load environment system?
    
    Specified by:
    
    doExportUsesSystemEnvironment in interface Settings
  - setResource
```
public void setResource(Resource resource)
```
    Description copied from interface: Settings
    
    Specify
    
    Specified by:
    
    setResource in interface Settings
  - setExecuteAtStart
```
public void setExecuteAtStart(java.lang.String execute)
```
    Specified by:
    
    setExecuteAtStart in interface Settings
    
    Parameters:
    
    execute - specify a string that will be pushed to the input stream at start
  - getExecuteAtStart
```
public java.lang.String getExecuteAtStart()
```
    Specified by:
    
    getExecuteAtStart in interface Settings
    
    Returns:
    
    execute at start string
  - setExecuteFileAtStart
```
public void setExecuteFileAtStart(Resource executeFileAtStart)
```
    Specified by:
    
    setExecuteFileAtStart in interface Settings
    
    Parameters:
    
    executeFileAtStart - file that will be read, parsed and executed at start
  - getExecuteFileAtStart
```
public Resource getExecuteFileAtStart()
```
    Specified by:
    
    getExecuteFileAtStart in interface Settings
    
    Returns:
    
    execute file at start
  - getResource
```
public Resource getResource()
```
    Specified by:
    
    getResource in interface Settings
  - clone
```
public java.lang.Object clone()
```
    Specified by:
    
    clone in interface Settings
    
    Overrides:
    
    clone in class java.lang.Object

Class SettingsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

editMode

historyFile

historyFilePermission

historySize

historyDisabled

historyPersistent

bellStyle

ansiConsole

inputStream

stdOut

stdErr

terminal

readInputrc

inputrc

isLogging

logFile

disableCompletion

quitHandler

operationManager

aliasFile

aliasEnabled

persistAlias

interruptHook

enableOperatorParser

manEnabled

aeshContext

exportEnabled

exportFile

persistExport

exportUsesSystemEnvironment

resource

execute

executeFileAtStart

Constructor Detail

SettingsImpl

SettingsImpl

Method Detail

resetToDefaults

setName

getName

getMode

setMode

getEditMode

resetEditMode

getOperationManager

getHistoryFilePermission

setHistoryFilePermission

getHistoryFile

setHistoryFile

getHistorySize

setHistorySize

getBellStyle

setBellStyle

isAnsiConsole

setAnsiConsole

getInputStream

setInputStream

getStdOut

setStdOut

getStdErr

setStdErr

getTerminal

setTerminal

getInputrc

setInputrc

isLogging

setLogging

isCompletionDisabled

setDisableCompletion

getLogFile

setLogFile

doReadInputrc

setReadInputrc