Package org.apache.maven.doxia.site.decoration

Class DecorationUtils

java.lang.Object

org.apache.maven.doxia.site.decoration.DecorationUtils

public class DecorationUtils
extends Object

Decoration model utilities.

Since:

1.7

Constructor Summary

Constructors

Constructor	Description
DecorationUtils()

Method Summary

Modifier and Type	Method	Description
static org.codehaus.plexus.util.xml.Xpp3Dom	getCustomChild(org.codehaus.plexus.util.xml.Xpp3Dom custom, String path)	Helper to get decoration custom DOM element by simply specifying a dotted path.
static String	getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom custom, String path)	Helper to get decoration custom DOM element value by simply specifying a dotted path.
static String	getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom custom, String path, String defaultValue)	Helper to get decoration custom DOM element value by simply specifying a dotted path.
static boolean	isLink(String href)
static boolean	startsWithAnyIgnoreCase(String string, String... searchStrings)

Methods inherited from class java.lang.Object

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

Constructor Detail

DecorationUtils

public DecorationUtils()

Method Detail

isLink

public static boolean isLink(String href)

startsWithAnyIgnoreCase

public static boolean startsWithAnyIgnoreCase(String string,
                                              String... searchStrings)

getCustomChild

public static org.codehaus.plexus.util.xml.Xpp3Dom getCustomChild(org.codehaus.plexus.util.xml.Xpp3Dom custom,
                                                                  String path)

Helper to get decoration custom DOM element by simply specifying a dotted path.

Parameters:

custom - the custom DOM element

path - the dotted path to the child

Returns:

null if any element in the path does not exist

Since:

1.8

getCustomValue

public static String getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom custom,
                                    String path)

Helper to get decoration custom DOM element value by simply specifying a dotted path.

Parameters:

custom - the custom DOM element

path - the dotted path to the child

Returns:

the element value or null if any element in the path does not exist

Since:

1.8

getCustomValue

public static String getCustomValue(org.codehaus.plexus.util.xml.Xpp3Dom custom,
                                    String path,
                                    String defaultValue)

Helper to get decoration custom DOM element value by simply specifying a dotted path.

Parameters:

custom - the custom DOM element

path - the dotted path to the child

defaultValue - default value

Returns:

the element value or the default value if any element in the path does not exist

Since:

1.8