java.lang.Object
- com.broadleafcommerce.metadata.dsl.core.extension.fields.SelectOption

All Implemented Interfaces:

Copyable<SelectOption>, Serializable
```
public class SelectOption
extends Object
implements Serializable, Copyable<SelectOption>
```
Represents an option within a SelectField.

Author:

Nick Crum (ncrum)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SelectOption.SelectOptionEnum
An enum interface used as a method for defining a finite list of SelectOption.

Constructor Summary

Constructors
Constructor	Description
`SelectOption()`
`SelectOption(SelectOption option)`
`SelectOption(String value, InternationalizedMessage label)`
`SelectOption(String value, String labelKey)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SelectOption`	`attribute(String key, Object value)`
`protected boolean`	`canEqual(Object other)`
`SelectOption`	`color(String color)`
`SelectOption`	`copy()`
`boolean`	`equals(Object o)`
`static List<SelectOption>`	`fromAllLocales()`	Returns the list of all installed locales converted to `SelectOption`.
`static List<SelectOption>`	`fromEnums(SelectOption.SelectOptionEnum[] optionEnums)`	Factory method to generate a set of `SelectOption` from the passed enumeration.
`static List<SelectOption>`	`fromLocales(List<Locale> locales)`	Returns the list of the specified locales converted to `SelectOption`.
`static List<SelectOption>`	`fromTimeZones()`	Returns the list of all `ZoneId.getAvailableZoneIds()` converted to `SelectOption`.
`static List<SelectOption>`	`fromTimeZones(Set<String> zoneIds)`	Returns the list of the specified time-zones converted to `SelectOption`.
`Map<String,Object>`	`getAttributes()`
`String`	`getColor()`	Optional color to display alongside the label
`InternationalizedMessage`	`getLabel()`	The user-friendly text that the user sees as the select option
`String`	`getValue()`	The underlying form value that the user selects
`int`	`hashCode()`
`SelectOption`	`label(InternationalizedMessage label)`
`SelectOption`	`label(String labelKey)`
`SelectOption`	`value(String value)`

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

- Constructor Detail
  - SelectOption
```
public SelectOption()
```
  - SelectOption
```
public SelectOption(String value,
                    String labelKey)
```
  - SelectOption
```
public SelectOption(String value,
                    InternationalizedMessage label)
```
  - SelectOption
```
public SelectOption(SelectOption option)
```
- Method Detail
  - copy
```
public SelectOption copy()
```
    Specified by:
    
    copy in interface Copyable<SelectOption>
    
    Returns:
    
    a deep copy of this instance
  - value
```
public SelectOption value(String value)
```
  - label
```
public SelectOption label(InternationalizedMessage label)
```
  - label
```
public SelectOption label(String labelKey)
```
  - color
```
public SelectOption color(String color)
```
  - attribute
```
public SelectOption attribute(String key,
                              Object value)
```
  - fromEnums
```
public static List<SelectOption> fromEnums(SelectOption.SelectOptionEnum[] optionEnums)
```
    Factory method to generate a set of SelectOption from the passed enumeration.
    
    Parameters:
    
    optionEnums - the enums
    
    Returns:
    
    the set of options
  - fromAllLocales
```
public static List<SelectOption> fromAllLocales()
```
    Returns the list of all installed locales converted to SelectOption.
    
    Returns:
    
    the list of all installed locales converted to SelectOption
    
    See Also:
    
    Locale.getAvailableLocales(), fromLocales(List)
  - fromLocales
```
public static List<SelectOption> fromLocales(List<Locale> locales)
```
    Returns the list of the specified locales converted to SelectOption. The value is retrieved from Locale.toLanguageTag(). The label represents the message property e.g. "locales.en-GB=English (GB)", where "en-GB" is retrieved from Locale.toLanguageTag().
    
    Parameters:
    
    locales - the locales to convert
    
    Returns:
    
    the list of locales converted to SelectOption
  - fromTimeZones
```
public static List<SelectOption> fromTimeZones()
```
    Returns the list of all ZoneId.getAvailableZoneIds() converted to SelectOption.
    
    Returns:
    
    the list of all ZoneId.getAvailableZoneIds() converted to SelectOption
  - fromTimeZones
```
public static List<SelectOption> fromTimeZones(Set<String> zoneIds)
```
    Returns the list of the specified time-zones converted to SelectOption. The value is the time-zone ID. The label represents the message property e.g. "time.zone.id.america_new_york=America/New_York".
    
    Parameters:
    
    zoneIds - the list of zone IDs
    
    Returns:
    
    the list of zone IDs converted to SelectOption
  - getValue
```
public String getValue()
```
    The underlying form value that the user selects
  - getLabel
```
public InternationalizedMessage getLabel()
```
    The user-friendly text that the user sees as the select option
    This label can be a message key for I18n concerns
  - getColor
```
public String getColor()
```
    Optional color to display alongside the label
  - getAttributes
```
public Map<String,Object> getAttributes()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class SelectOption

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SelectOption

SelectOption

SelectOption

SelectOption

Method Detail

copy

value

label

label

color

attribute

fromEnums

fromAllLocales

fromLocales

fromTimeZones

fromTimeZones

getValue

getLabel

getColor

getAttributes

equals

canEqual

hashCode