Package picocli

Class CommandLine.Model.FieldBinding

java.lang.Object

picocli.CommandLine.Model.FieldBinding

All Implemented Interfaces:

CommandLine.Model.IGetter, CommandLine.Model.IScoped, CommandLine.Model.ISetter

Enclosing class:

CommandLine.Model

static class CommandLine.Model.FieldBinding
extends Object
implements CommandLine.Model.IGetter, CommandLine.Model.ISetter, CommandLine.Model.IScoped

Field Summary

Fields

Modifier and Type	Field	Description
private final Field	field
private final CommandLine.Model.IScope	scope

Constructor Summary

Constructors

Constructor	Description
FieldBinding(Object scope, Field field)
FieldBinding(CommandLine.Model.IScope scope, Field field)

Method Summary

Modifier and Type	Method	Description
<T> T	get()	Returns the current value of the binding.
CommandLine.Model.IScope	getScope()	Get the CommandLine.Model.IScope instance.
<T> T	set(T value)	Sets the new value of the option or positional parameter.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

scope

private final CommandLine.Model.IScope scope

field

private final Field field

Constructor Details

FieldBinding

FieldBinding(Object scope,
 Field field)

FieldBinding

FieldBinding(CommandLine.Model.IScope scope,
 Field field)

Method Details

getScope

public CommandLine.Model.IScope getScope()

Description copied from interface: CommandLine.Model.IScoped

Get the CommandLine.Model.IScope instance.

Specified by:

getScope in interface CommandLine.Model.IScoped

Returns:

CommandLine.Model.IScope instance

get

public <T> T get()
          throws CommandLine.PicocliException

Description copied from interface: CommandLine.Model.IGetter

Returns the current value of the binding. For multi-value options and positional parameters, this method returns an array, collection or map to add values to.

Specified by:

get in interface CommandLine.Model.IGetter

Throws:

CommandLine.PicocliException - if a problem occurred while obtaining the current value

set

public <T> T set(T value)
          throws CommandLine.PicocliException

Description copied from interface: CommandLine.Model.ISetter

Sets the new value of the option or positional parameter.

Specified by:

set in interface CommandLine.Model.ISetter

Type Parameters:

T - type of the value

Parameters:

value - the new value of the option or positional parameter

Returns:

the previous value of the binding (if supported by this binding)

Throws:

CommandLine.PicocliException - if a problem occurred while setting the new value

toString

public String toString()

Overrides:

toString in class Object