CRaSH (CRaSH Doc API 1.3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.shell.impl.command
Class CRaSH

java.lang.Object
  org.crsh.shell.impl.command.CRaSH

public class CRaSH

extends Object

Field Summary
`(package private) PluginContext`	`context` .
`(package private) ArrayList<Language>`	`langs` .
`private ArrayList<CommandResolver>`	`resolvers` .
`(package private) LanguageCommandResolver`	`scriptResolver` .

Constructor Summary
`CRaSH(PluginContext context)` Create a new CRaSH.

Method Summary
`CRaSHSession`	`createSession(Principal user)`
`Command<?>`	`getCommand(String name)` Attempt to obtain a command instance.
`Iterable<Map.Entry<String,String>>`	`getCommands()`
`PluginContext`	`getContext()` Returns the plugin context.

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

Field Detail

context

final PluginContext context

scriptResolver

final LanguageCommandResolver scriptResolver

resolvers

private final ArrayList<CommandResolver> resolvers

langs

final ArrayList<Language> langs

Constructor Detail

CRaSH

public CRaSH(PluginContext context)
      throws NullPointerException

Create a new CRaSH.

Parameters:: context - the plugin context
Throws:: NullPointerException - if the context argument is null

Method Detail

createSession

public CRaSHSession createSession(Principal user)

getContext

public PluginContext getContext()

Returns the plugin context.

Returns:: the plugin context

getCommand

public Command<?> getCommand(String name)
                      throws CommandException,
                             NullPointerException

Attempt to obtain a command instance. Null is returned when such command does not exist.

Parameters:: name - the command name
Returns:: a command instance
Throws:: CommandException - if an error occured preventing the command creation; NullPointerException - if the name argument is null

getCommands

public Iterable<Map.Entry<String,String>> getCommands()