Package io.guise.framework.converter

Class LocaleStringLiteralConverter

java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.event.GuiseBoundPropertyObject
io.guise.framework.converter.AbstractConverter<Locale,String>
io.guise.framework.converter.LocaleStringLiteralConverter
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Converter<Locale,String>
public class LocaleStringLiteralConverter extends AbstractConverter<Locale,String>
An object that can convert a locale to a string using the current locale. This implementation does not support conversion of a literal value to a locale.
Author:
Garret Wilson

  • Field Summary

    Fields inherited from class com.globalmentor.beans.BoundPropertyObject

    NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

    Fields inherited from interface io.guise.framework.converter.Converter

    INVALID_VALUE_MESSAGE_PROPERTY

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocaleStringLiteralConverter(LocaleStringLiteralStyle style)
    Locale style constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Locale
    convertLiteral(String literal)
    Converts a literal representation of a value from the lexical space into a value in the value space.
    String
    convertValue(Locale value)
    Converts a value from the value space to a literal value in the lexical space.
    LocaleStringLiteralStyle
    getStyle()
     

    Methods inherited from class io.guise.framework.converter.AbstractConverter

    getInvalidValueMessage, isEquivalent, isValidLiteral, setInvalidValueMessage

    Methods inherited from class io.guise.framework.event.GuiseBoundPropertyObject

    getSession

    Methods inherited from class com.globalmentor.beans.BoundPropertyObject

    addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.guise.framework.converter.Converter

    getSession

    Methods inherited from interface com.globalmentor.beans.PropertyBindable

    addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

  • Constructor Details

    • LocaleStringLiteralConverter

      public LocaleStringLiteralConverter(LocaleStringLiteralStyle style)
      Locale style constructor.
      Parameters:
      style - The locale representation style.
      Throws:
      NullPointerException - if the given locale style is null.

  • Method Details

    • getStyle

      public LocaleStringLiteralStyle getStyle()
      Returns:
      The locale representation style.

    • convertValue

      public String convertValue(Locale value) throws ConversionException
      Description copied from interface: Converter
      Converts a value from the value space to a literal value in the lexical space.
      Parameters:
      value - The value in the value space to convert.
      Returns:
      The converted value in the lexical space, or null if the given literal is null.
      Throws:
      ConversionException - if the value cannot be converted.

    • convertLiteral

      public Locale convertLiteral(String literal) throws ConversionException
      Converts a literal representation of a value from the lexical space into a value in the value space.

      This version throws a conversion exception if the literal is not null.

      Parameters:
      literal - The literal value in the lexical space to convert.
      Returns:
      The converted value in the value space, or null if the given literal is null.
      Throws:
      ConversionException - if the literal value cannot be converted.