Package org.apache.felix.service.command
Interface CommandSession
- All Known Implementing Classes:
CommandSessionImpl
public interface CommandSession
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close this command session.Convert an object to another type.execute
(CharSequence commandline) Execute a program in this session.Convert an object to string form (CharSequence).Get the value of a variable.Return the PrintStream for the console.Return the input stream that is the first of the pipeline.void
Set the value of a variable.
-
Method Details
-
execute
Execute a program in this session.- Parameters:
commandline
-- Returns:
- the result of the execution
- Throws:
Exception
-
close
void close()Close this command session. After the session is closed, it will throw IllegalStateException when it is used. -
getKeyboard
InputStream getKeyboard()Return the input stream that is the first of the pipeline. This stream is sometimes necessary to communicate directly to the end user. For example, a "less" or "more" command needs direct input from the keyboard to control the paging.- Returns:
- InpuStream used closest to the user or null if input is from a file.
-
getConsole
PrintStream getConsole()Return the PrintStream for the console. This must always be the stream "closest" to the user. This stream can be used to post messages that bypass the piping. If the output is piped to a file, then the object returned must be null.- Returns:
-
get
Get the value of a variable.- Parameters:
name
-- Returns:
-
put
Set the value of a variable.- Parameters:
name
- Name of the variable.value
- Value of the variable
-
format
Convert an object to string form (CharSequence). The level is defined in the Converter interface, it can be one of INSPECT, LINE, PART. This function always returns a non null value. As a last resort, toString is called on the Object.- Parameters:
target
-level
-- Returns:
-
convert
Convert an object to another type.
-