org.springframework.shell.converters
Class BooleanConverter

java.lang.Object
  extended by org.springframework.shell.converters.BooleanConverter
All Implemented Interfaces:
Converter<Boolean>

public class BooleanConverter
extends Object
implements Converter<Boolean>

Converter for Boolean.

Since:
1.0

Constructor Summary
BooleanConverter()
           
 
Method Summary
 Boolean convertFromText(String value, Class<?> requiredType, String optionContext)
          Converts from the given String value to type T
 boolean getAllPossibleValues(List<Completion> completions, Class<?> requiredType, String existingData, String optionContext, MethodTarget target)
          Populates the given list with the possible completions
 boolean supports(Class<?> requiredType, String optionContext)
          Indicates whether this converter supports the given type in the given option context
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanConverter

public BooleanConverter()
Method Detail

convertFromText

public Boolean convertFromText(String value,
                               Class<?> requiredType,
                               String optionContext)
Description copied from interface: Converter
Converts from the given String value to type T

Specified by:
convertFromText in interface Converter<Boolean>
Parameters:
value - the value to convert
requiredType - the type being converted to; can't be null
optionContext - a non-null string that customises the behaviour of this converter for a given CliOption of a given CliCommand; the contents will have special meaning to this converter (e.g. be a comma-separated list of keywords known to this converter)
Returns:
see above

getAllPossibleValues

public boolean getAllPossibleValues(List<Completion> completions,
                                    Class<?> requiredType,
                                    String existingData,
                                    String optionContext,
                                    MethodTarget target)
Description copied from interface: Converter
Populates the given list with the possible completions

Specified by:
getAllPossibleValues in interface Converter<Boolean>
Parameters:
completions - the list to populate; can't be null
requiredType - the type of parameter for which a string is being entered
existingData - what the user has typed so far
optionContext - a non-null string that customises the behaviour of this converter for a given CliOption of a given CliCommand; the contents will have special meaning to this converter (e.g. be a comma-separated list of keywords known to this converter)
Returns:
true if all the added completions are complete values, or false if the user can press TAB to add further information to some or all of them

supports

public boolean supports(Class<?> requiredType,
                        String optionContext)
Description copied from interface: Converter
Indicates whether this converter supports the given type in the given option context

Specified by:
supports in interface Converter<Boolean>
Parameters:
requiredType - the type being checked
optionContext - a non-null string that customises the behaviour of this converter for a given CliOption of a given CliCommand; the contents will have special meaning to this converter (e.g. be a comma-separated list of keywords known to this converter)
Returns:
see above