net.sf.xolite
Class Attributes

java.lang.Object
  net.sf.xolite.Attributes

public class Attributes
extends Object

A helper class to get formatted value out of XML element attributes.
Note: this helper assume that attributes have no namespace (as it is usually the case). For the rare case where there is an attribute with namespace that has not a simple string value, you should get it directly from the XMLEventParser interface and interpret it with ad-hoc code.

Author:

Olivier Berlanger

Constructor Summary

Attributes()

Method Summary

static String	dateToString(Date dat, String pattern)
static String	dimensionToString(Dimension dim)
protected static String	getAttributeRawValue(String attrName, boolean mandatory, XMLEventParser parser)
protected static boolean	getBoolean(String attrName, boolean defaultValue, boolean mandatory, XMLEventParser parser)
static boolean	getBoolean(String attrName, boolean defaultValue, XMLEventParser parser)
protected static Date	getDate(String attrName, String pattern, Date defaultValue, boolean mandatory, XMLEventParser parser)
static Date	getDate(String attrName, String pattern, Date defaultValue, XMLEventParser parser)
protected static DateFormat	getDateFormat(String pattern) Method sharing the DateFormat used for parsing/formatting but ensuring that they are shared across threads (because they are not thread-safe).
protected static Dimension	getDimension(String attrName, Dimension defaultValue, boolean mandatory, XMLEventParser parser)
static Dimension	getDimension(String attrName, Dimension defaultValue, XMLEventParser parser)
protected static double	getDouble(String attrName, double defaultValue, boolean mandatory, XMLEventParser parser)
static double	getDouble(String attrName, double defaultValue, XMLEventParser parser)
static <T extends Enum<T>> T	getEnum(String attrName, T defaultValue, Class<T> enumType, XMLEventParser parser)
protected static <T extends Enum<T>> T	getEnum(String attrName, T defaultValue, Class<T> enumType, XMLEventParser parser, boolean mandatory)
protected static int	getInt(String attrName, int defaultValue, boolean mandatory, XMLEventParser parser)
static int	getInt(String attrName, int defaultValue, XMLEventParser parser)
protected static int[]	getIntArray(String attrName, int[] defaultValue, boolean mandatory, XMLEventParser parser)
static int[]	getIntArray(String attrName, int[] defaultValue, XMLEventParser parser)
protected static long	getLong(String attrName, long defaultValue, boolean mandatory, XMLEventParser parser)
static long	getLong(String attrName, long defaultValue, XMLEventParser parser)
static boolean	getMandatoryBoolean(String attrName, XMLEventParser parser)
static Date	getMandatoryDate(String attrName, String pattern, XMLEventParser parser)
static Dimension	getMandatoryDimension(String attrName, XMLEventParser parser)
static double	getMandatoryDouble(String attrName, XMLEventParser parser)
static <T extends Enum<T>> T	getMandatoryEnum(String attrName, Class<T> enumType, XMLEventParser parser)
static int	getMandatoryInt(String attrName, XMLEventParser parser)
static int[]	getMandatoryIntArray(String attrName, XMLEventParser parser)
static long	getMandatoryLong(String attrName, XMLEventParser parser)
static Point	getMandatoryPoint(String attrName, XMLEventParser parser)
static Rectangle	getMandatoryRectangle(String attrName, XMLEventParser parser)
static String	getMandatoryString(String attrName, XMLEventParser parser)
static List<String>	getMandatoryStringList(String attrName, String separator, XMLEventParser parser)
protected static Point	getPoint(String attrName, Point defaultValue, boolean mandatory, XMLEventParser parser)
static Point	getPoint(String attrName, Point defaultValue, XMLEventParser parser)
protected static Rectangle	getRectangle(String attrName, Rectangle defaultValue, boolean mandatory, XMLEventParser parser)
static Rectangle	getRectangle(String attrName, Rectangle defaultValue, XMLEventParser parser)
protected static String	getString(String attrName, String defaultValue, boolean mandatory, XMLEventParser parser)
static String	getString(String attrName, String defaultValue, XMLEventParser parser)
protected static List<String>	getStringList(String attrName, String separator, boolean mandatory, XMLEventParser parser) Warning: This method return an unmodifiable list (not an instance of the usual ArrayList implementation).
static List<String>	getStringList(String attrName, String separator, XMLEventParser parser)
static String	intArrayToString(int[] values)
static String	iterableToString(Iterable<? extends Object> iterabl, String separator, String replacement)
static String	listToString(List<? extends Object> lst, String separator, String replacement)
static String	objectArrayToString(Object[] values)
static String	objectArrayToString(Object[] values, String separator, String replacement)
static String	pointToString(Point pt)
static String	rectangleToString(Rectangle rect)
static String	stringListToString(List<String> list, String separator)
static boolean	stringToBoolean(String value)
static Date	stringToDate(String src, String pattern)
static int[]	stringToIntArray(String value)
static List<String>	stringToStringList(String src, String separator) Warning: This method return an unmodifiable list (not an instance of the usual ArrayList implementation).

Methods inherited from class java.lang.Object

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

Constructor Detail

Attributes

public Attributes()

Method Detail

getString

public static String getString(String attrName,
                               String defaultValue,
                               XMLEventParser parser)
                        throws XMLParseException

Throws:

XMLParseException

getMandatoryString

public static String getMandatoryString(String attrName,
                                        XMLEventParser parser)
                                 throws XMLParseException

Throws:

XMLParseException

getInt

public static int getInt(String attrName,
                         int defaultValue,
                         XMLEventParser parser)
                  throws XMLParseException

Throws:

XMLParseException

getMandatoryInt

public static int getMandatoryInt(String attrName,
                                  XMLEventParser parser)
                           throws XMLParseException

Throws:

XMLParseException

getEnum

public static <T extends Enum<T>> T getEnum(String attrName,
                                            T defaultValue,
                                            Class<T> enumType,
                                            XMLEventParser parser)
                                 throws XMLParseException

Throws:

XMLParseException

getMandatoryEnum

public static <T extends Enum<T>> T getMandatoryEnum(String attrName,
                                                     Class<T> enumType,
                                                     XMLEventParser parser)
                                          throws XMLParseException

Throws:

XMLParseException

getDouble

public static double getDouble(String attrName,
                               double defaultValue,
                               XMLEventParser parser)
                        throws XMLParseException

Throws:

XMLParseException

getMandatoryDouble

public static double getMandatoryDouble(String attrName,
                                        XMLEventParser parser)
                                 throws XMLParseException

Throws:

XMLParseException

getIntArray

public static int[] getIntArray(String attrName,
                                int[] defaultValue,
                                XMLEventParser parser)
                         throws XMLParseException

Throws:

XMLParseException

getMandatoryIntArray

public static int[] getMandatoryIntArray(String attrName,
                                         XMLEventParser parser)
                                  throws XMLParseException

Throws:

XMLParseException

getStringList

public static List<String> getStringList(String attrName,
                                         String separator,
                                         XMLEventParser parser)
                                  throws XMLParseException

Throws:

XMLParseException

getMandatoryStringList

public static List<String> getMandatoryStringList(String attrName,
                                                  String separator,
                                                  XMLEventParser parser)
                                           throws XMLParseException

Throws:

XMLParseException

getLong

public static long getLong(String attrName,
                           long defaultValue,
                           XMLEventParser parser)
                    throws XMLParseException

Throws:

XMLParseException

getMandatoryLong

public static long getMandatoryLong(String attrName,
                                    XMLEventParser parser)
                             throws XMLParseException

Throws:

XMLParseException

getBoolean

public static boolean getBoolean(String attrName,
                                 boolean defaultValue,
                                 XMLEventParser parser)
                          throws XMLParseException

Throws:

XMLParseException

getMandatoryBoolean

public static boolean getMandatoryBoolean(String attrName,
                                          XMLEventParser parser)
                                   throws XMLParseException

Throws:

XMLParseException

getPoint

public static Point getPoint(String attrName,
                             Point defaultValue,
                             XMLEventParser parser)
                      throws XMLParseException

Throws:

XMLParseException

getMandatoryPoint

public static Point getMandatoryPoint(String attrName,
                                      XMLEventParser parser)
                               throws XMLParseException

Throws:

XMLParseException

getDimension

public static Dimension getDimension(String attrName,
                                     Dimension defaultValue,
                                     XMLEventParser parser)
                              throws XMLParseException

Throws:

XMLParseException

getMandatoryDimension

public static Dimension getMandatoryDimension(String attrName,
                                              XMLEventParser parser)
                                       throws XMLParseException

Throws:

XMLParseException

getRectangle

public static Rectangle getRectangle(String attrName,
                                     Rectangle defaultValue,
                                     XMLEventParser parser)
                              throws XMLParseException

Throws:

XMLParseException

getMandatoryRectangle

public static Rectangle getMandatoryRectangle(String attrName,
                                              XMLEventParser parser)
                                       throws XMLParseException

Throws:

XMLParseException

getDate

public static Date getDate(String attrName,
                           String pattern,
                           Date defaultValue,
                           XMLEventParser parser)
                    throws XMLParseException

Throws:

XMLParseException

getMandatoryDate

public static Date getMandatoryDate(String attrName,
                                    String pattern,
                                    XMLEventParser parser)
                             throws XMLParseException

Throws:

XMLParseException

intArrayToString

public static final String intArrayToString(int[] values)

objectArrayToString

public static final String objectArrayToString(Object[] values)

objectArrayToString

public static final String objectArrayToString(Object[] values,
                                               String separator,
                                               String replacement)

listToString

public static final String listToString(List<? extends Object> lst,
                                        String separator,
                                        String replacement)

iterableToString

public static final String iterableToString(Iterable<? extends Object> iterabl,
                                            String separator,
                                            String replacement)

pointToString

public static final String pointToString(Point pt)

dimensionToString

public static final String dimensionToString(Dimension dim)

rectangleToString

public static final String rectangleToString(Rectangle rect)

dateToString

public static final String dateToString(Date dat,
                                        String pattern)

getAttributeRawValue

protected static String getAttributeRawValue(String attrName,
                                             boolean mandatory,
                                             XMLEventParser parser)
                                      throws XMLParseException

Throws:

XMLParseException

getString

protected static String getString(String attrName,
                                  String defaultValue,
                                  boolean mandatory,
                                  XMLEventParser parser)
                           throws XMLParseException

Throws:

XMLParseException

getBoolean

protected static boolean getBoolean(String attrName,
                                    boolean defaultValue,
                                    boolean mandatory,
                                    XMLEventParser parser)
                             throws XMLParseException

Throws:

XMLParseException

getInt

protected static int getInt(String attrName,
                            int defaultValue,
                            boolean mandatory,
                            XMLEventParser parser)
                     throws XMLParseException

Throws:

XMLParseException

getEnum

protected static <T extends Enum<T>> T getEnum(String attrName,
                                               T defaultValue,
                                               Class<T> enumType,
                                               XMLEventParser parser,
                                               boolean mandatory)
                                    throws XMLParseException

Throws:

XMLParseException

getDouble

protected static double getDouble(String attrName,
                                  double defaultValue,
                                  boolean mandatory,
                                  XMLEventParser parser)
                           throws XMLParseException

Throws:

XMLParseException

getIntArray

protected static int[] getIntArray(String attrName,
                                   int[] defaultValue,
                                   boolean mandatory,
                                   XMLEventParser parser)
                            throws XMLParseException

Throws:

XMLParseException

getDimension

protected static Dimension getDimension(String attrName,
                                        Dimension defaultValue,
                                        boolean mandatory,
                                        XMLEventParser parser)
                                 throws XMLParseException

Throws:

XMLParseException

getPoint

protected static Point getPoint(String attrName,
                                Point defaultValue,
                                boolean mandatory,
                                XMLEventParser parser)
                         throws XMLParseException

Throws:

XMLParseException

getRectangle

protected static Rectangle getRectangle(String attrName,
                                        Rectangle defaultValue,
                                        boolean mandatory,
                                        XMLEventParser parser)
                                 throws XMLParseException

Throws:

XMLParseException

getDate

protected static Date getDate(String attrName,
                              String pattern,
                              Date defaultValue,
                              boolean mandatory,
                              XMLEventParser parser)
                       throws XMLParseException

Throws:

XMLParseException

getDateFormat

protected static DateFormat getDateFormat(String pattern)

Method sharing the DateFormat used for parsing/formatting but ensuring that they are shared across threads (because they are not thread-safe).

getStringList

protected static List<String> getStringList(String attrName,
                                            String separator,
                                            boolean mandatory,
                                            XMLEventParser parser)
                                     throws XMLParseException

Warning: This method return an unmodifiable list (not an instance of the usual ArrayList implementation).

Parameters:

attrName - The name of the attribute holding the list data in the current element of the parser.

separator - The separator regular expression (see String.split(..))

mandatory - Flag saying if this attribute is mandatory in its XML element.

parser - The XML parser

Returns:

The content of the attribute as a list of string.

Throws:

XMLParseException - if attribute is mandatory and not present or if parsing failed.

getLong

protected static long getLong(String attrName,
                              long defaultValue,
                              boolean mandatory,
                              XMLEventParser parser)
                       throws XMLParseException

Throws:

XMLParseException

stringToBoolean

public static final boolean stringToBoolean(String value)

stringToIntArray

public static final int[] stringToIntArray(String value)

stringToStringList

public static final List<String> stringToStringList(String src,
                                                    String separator)

Warning: This method return an unmodifiable list (not an instance of the usual ArrayList implementation).

Parameters:

src - The string to transform to a List.

separator - The list items separator.

Returns:

The content of the given string as a List.

stringListToString

public static final String stringListToString(List<String> list,
                                              String separator)

stringToDate

public static final Date stringToDate(String src,
                                      String pattern)
                               throws ParseException

Throws:

ParseException