SessionFunction (JSimpleDB CLI Classes 2.4.2 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.jsimpledb.parse.func.AbstractFunction
- - org.jsimpledb.parse.func.SimpleFunction
  - - org.jsimpledb.cli.func.SimpleCliFunction
    - - org.jsimpledb.cli.func.SessionFunction

All Implemented Interfaces:: Function

public class SessionFunction
extends SimpleCliFunction

Field Summary
- Fields inherited from class org.jsimpledb.parse.func.SimpleFunction
  maxArgs, minArgs
- Fields inherited from class org.jsimpledb.parse.func.AbstractFunction
  log, name, spaceParser

Constructor Summary

Constructors
Constructor and Description

SessionFunction()

Method Summary

Methods
Modifier and Type	Method and Description
`protected ConstValue`	`apply(CliSession session, Value[] params)` Apply this function to the given values.
`String`	`getHelpSummary()`
`EnumSet<SessionMode>`	`getSessionModes()`
`String`	`getUsage()`

Methods inherited from class org.jsimpledb.cli.func.SimpleCliFunction
apply

Methods inherited from class org.jsimpledb.parse.func.SimpleFunction
apply, getMaxArgs, getMinArgs, parseParams

Methods inherited from class org.jsimpledb.parse.func.AbstractFunction
getHelpDetail, getName, parseExpressionParams, parseNextParameter

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

- Constructor Detail
  - SessionFunction
```
public SessionFunction()
```
- Method Detail
  - getHelpSummary
```
public String getHelpSummary()
```
  - getUsage
```
public String getUsage()
```
  - getSessionModes
```
public EnumSet<SessionMode> getSessionModes()
```
    Specified by:
    
    getSessionModes in interface Function
    
    Overrides:
    
    getSessionModes in class AbstractFunction
  - apply
```
protected ConstValue apply(CliSession session,
               Value[] params)
```
    Description copied from class: SimpleCliFunction
    
    Apply this function to the given values.
    
    Specified by:
    
    apply in class SimpleCliFunction
    
    Parameters:
    session - CLI session
    params - parsed parameters; will already be checked between SimpleFunction.getMinArgs() and SimpleFunction.getMaxArgs()
    
    Returns:
    value returned by this function

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2016. All rights reserved.