org.jboss.forge.addon.ui.util

Class InputComponents

java.lang.Object

org.jboss.forge.addon.ui.util.InputComponents

public final class InputComponents
extends Object

Utilities for InputComponent objects

Author:

George Gastaldi

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_SHORT_NAME

Constructor Summary

Constructors

Constructor and Description
InputComponents()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	areElementsEqual(Iterable<?> iterable1, Iterable<?> iterable2) Determines whether two iterables contain equal elements in the same order.
static boolean	areEqual(Object a, Object b) Determines whether two possibly-null objects are equal.
static Object	convertToUIInputValue(ConverterFactory converterFactory, InputComponent<?,?> input, Object value) Returns the converted value that matches the input.
static <VALUETYPE> UICompleter<VALUETYPE>	getCompleterFor(InputComponent<?,VALUETYPE> inputComponent) Returns the completer associated with this InputComponent or null if it is not available
static String	getInputType(InputComponent<?,?> input)
static <IMPLTYPE,VALUETYPE> Converter<VALUETYPE,String>	getItemLabelConverter(ConverterFactory converterFactory, SelectComponent<IMPLTYPE,VALUETYPE> input) Returns the item label converter, that is
static String	getLabelFor(InputComponent<?,?> input, boolean addColon) Returns the label for this component
static Object	getValueFor(InputComponent<?,?> component) Returns the value stored in this InputComponent.
static boolean	hasValue(InputComponent<?,?> input) Returns if there is a value set for this InputComponent
static void	setDefaultValueFor(ConverterFactory converterFactory, InputComponent<?,Object> component, Object value) Sets the default value in the provided InputComponent, making any necessary conversions
static void	setValueFor(ConverterFactory converterFactory, InputComponent<?,?> component, Object value) Sets the value in the provided InputComponent, making any necessary conversions
static String	validateRequired(InputComponent<?,?> input) Validate if the input has a value.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SHORT_NAME

public static final char DEFAULT_SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

InputComponents

public InputComponents()

Method Detail

getInputType

public static String getInputType(InputComponent<?,?> input)

Returns:

the InputType object associated to this InputComponent

getValueFor

public static Object getValueFor(InputComponent<?,?> component)

Returns the value stored in this InputComponent. null if the component is null

setValueFor

public static void setValueFor(ConverterFactory converterFactory,
               InputComponent<?,?> component,
               Object value)

Sets the value in the provided InputComponent, making any necessary conversions

Parameters:

component -

value -

setDefaultValueFor

public static void setDefaultValueFor(ConverterFactory converterFactory,
                      InputComponent<?,Object> component,
                      Object value)

Sets the default value in the provided InputComponent, making any necessary conversions

Parameters:

component -

value -

convertToUIInputValue

public static Object convertToUIInputValue(ConverterFactory converterFactory,
                           InputComponent<?,?> input,
                           Object value)

Returns the converted value that matches the input. Throws IllegalArgumentException if input is a SelectComponent and the value cannot be converted

hasValue

public static boolean hasValue(InputComponent<?,?> input)

Returns if there is a value set for this InputComponent

validateRequired

public static String validateRequired(InputComponent<?,?> input)

Validate if the input has a value. If not, return the error message

Parameters:

input -

Returns:

getItemLabelConverter

public static <IMPLTYPE,VALUETYPE> Converter<VALUETYPE,String> getItemLabelConverter(ConverterFactory converterFactory,
                                                                     SelectComponent<IMPLTYPE,VALUETYPE> input)

Returns the item label converter, that is

Parameters:

converterFactory - May be null

input -

Returns:

the item label converter of a SelectComponent or a Converter instance from the ConverterFactory parameter if not null

getLabelFor

public static String getLabelFor(InputComponent<?,?> input,
                 boolean addColon)

Returns the label for this component

Parameters:

input - the input component

addColon - should a colon be added in the end of the label ?

Returns:

the label with a colon in the end if addColon is true

getCompleterFor

public static <VALUETYPE> UICompleter<VALUETYPE> getCompleterFor(InputComponent<?,VALUETYPE> inputComponent)

Returns the completer associated with this InputComponent or null if it is not available

Parameters:

inputComponent -

Returns:

the UICompleter associated with this InputComponent or null if not available or the InputComponent does not implement HasCompleter

areEqual

public static boolean areEqual(Object a,
               Object b)

Determines whether two possibly-null objects are equal. Returns:

• true if a and b are both null.
• true if a and b are both non-null and they are equal according to Object.equals(Object).
• false in all other situations.

This assumes that any non-null objects passed to this function conform to the equals() contract.

areElementsEqual

public static boolean areElementsEqual(Iterable<?> iterable1,
                       Iterable<?> iterable2)

Determines whether two iterables contain equal elements in the same order. More specifically, this method returns true if iterable1 and iterable2 contain the same number of elements and every element of iterable1 is equal to the corresponding element of iterable2.