org.springframework.shell

Class ParameterDescription

java.lang.Object

org.springframework.shell.ParameterDescription

public class ParameterDescription
extends Object

Encapsulates information about a shell invokable method parameter, so that it can be documented.

Instances of this class are constructed by ParameterResolver.describe(MethodParameter).

Author:

Eric Bottard

Constructor Summary

Constructors

Constructor and Description
ParameterDescription(org.springframework.core.MethodParameter parameter, String type)

Method Summary

Modifier and Type	Method and Description
Optional<String>	defaultValue()
ParameterDescription	defaultValue(String defaultValue)
Optional<String>	defaultValueWhenFlag()
javax.validation.metadata.ElementDescriptor	elementDescriptor()
ParameterDescription	elementDescriptor(javax.validation.metadata.ElementDescriptor descriptor)
boolean	equals(Object o)
String	formal()
ParameterDescription	formal(String formal)
int	hashCode()
String	help()
ParameterDescription	help(String help)
List<String>	keys()
ParameterDescription	keys(List<String> keys)
boolean	mandatoryKey()
ParameterDescription	mandatoryKey(boolean mandatoryKey)
static ParameterDescription	outOf(org.springframework.core.MethodParameter parameter)
org.springframework.core.MethodParameter	parameter()
String	toString()
String	type()
ParameterDescription	whenFlag(String defaultValue)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterDescription

public ParameterDescription(org.springframework.core.MethodParameter parameter,
                            String type)

Method Detail

outOf

public static ParameterDescription outOf(org.springframework.core.MethodParameter parameter)

help

public ParameterDescription help(String help)

mandatoryKey

public boolean mandatoryKey()

keys

public List<String> keys()

defaultValue

public Optional<String> defaultValue()

defaultValue

public ParameterDescription defaultValue(String defaultValue)

whenFlag

public ParameterDescription whenFlag(String defaultValue)

keys

public ParameterDescription keys(List<String> keys)

mandatoryKey

public ParameterDescription mandatoryKey(boolean mandatoryKey)

elementDescriptor

public javax.validation.metadata.ElementDescriptor elementDescriptor()

Returns:

an ElementDescriptor used to discover constraints. May be null.

elementDescriptor

public ParameterDescription elementDescriptor(javax.validation.metadata.ElementDescriptor descriptor)

type

public String type()

formal

public String formal()

help

public String help()

defaultValueWhenFlag

public Optional<String> defaultValueWhenFlag()

formal

public ParameterDescription formal(String formal)

toString

public String toString()

Overrides:

toString in class Object

parameter

public org.springframework.core.MethodParameter parameter()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object