org.savantbuild.parser.groovy

Class GroovyTools

java.lang.Object

org.savantbuild.parser.groovy.GroovyTools

public class GroovyTools
extends java.lang.Object

Groovy helpers.

Constructor Summary

Constructors

Constructor and Description
GroovyTools()

Method Summary

Modifier and Type	Method and Description
static boolean	attributesValid(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Collection<java.lang.String> possibleAttributes, java.util.Collection<java.lang.String> requiredAttributes, java.util.Map<java.lang.String,java.lang.Class<?>> types) Ensures that the attributes are valid.
static <T> void	convertListItems(java.util.List list, java.lang.Class<T> type, java.util.function.Function<java.lang.Object,T> function) Converts all of the list elements to the specified type by calling the function for any list elements that are not the correct type.
static boolean	hasAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, java.lang.Iterable<java.lang.String> attributeNames) Checks if the given attributes Map has all of the given attribute names.
static boolean	hasAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, java.lang.String... attributeNames) Checks if the given attributes Map has all of the given attribute names.
static boolean	hasAttributeTypes(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.String,java.lang.Class<?>> types) Checks if the given attributes Map has the correct types.
static void	putDefaults(java.util.Map<java.lang.String,java.lang.Object> map, java.util.Map<java.lang.String,java.lang.Object> defaults) Puts all of the values from the defaults map into the main map if they are absent.
static java.util.List<java.lang.String>	toListOfStrings(java.lang.Object value) Converts the object to a List of Strings.
static java.lang.String	toString(java.util.Map<java.lang.String,java.lang.Object> attributes, java.lang.String key) Safely converts an attribute to a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyTools

public GroovyTools()

Method Detail

attributesValid

public static boolean attributesValid(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                      java.util.Collection<java.lang.String> possibleAttributes,
                                      java.util.Collection<java.lang.String> requiredAttributes,
                                      java.util.Map<java.lang.String,java.lang.Class<?>> types)

Ensures that the attributes are valid. This checks if the attributes are null and there are no required attributes. If this is the case, it returns true. Otherwise, the attributes must be a Map and must contain the required attributes and have the correct attribute types.

Parameters:

attributes - The attributes object.

possibleAttributes - The list of possible attributes. If an attributes is specified that doesn't exist in this Collection, false will be returned.

requiredAttributes - A list of required attributes.

types - The attribute types.

Returns:

True if the attributes are valid, false otherwise.

convertListItems

public static <T> void convertListItems(java.util.List list,
                                        java.lang.Class<T> type,
                                        java.util.function.Function<java.lang.Object,T> function)

Converts all of the list elements to the specified type by calling the function for any list elements that are not the correct type.

Type Parameters:

T - The type.

Parameters:

list - The list.

type - The type.

function - The function that is used to convert to the correct type.

hasAttributeTypes

public static boolean hasAttributeTypes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                        java.util.Map<java.lang.String,java.lang.Class<?>> types)

Checks if the given attributes Map has the correct types. This handles the GString case since that is a Groovy special class that is converted to String dynamically.

Parameters:

attributes - The attributes map.

types - The types.

Returns:

True if the map contains the correct types, false otherwise.

hasAttributes

public static boolean hasAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                    java.lang.Iterable<java.lang.String> attributeNames)

Checks if the given attributes Map has all of the given attribute names. The values for the attribute names must be non-null.

Parameters:

attributes - The attributes map.

attributeNames - The attribute names.

Returns:

True if the map contains all of the attribute names, false otherwise.

hasAttributes

public static boolean hasAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                    java.lang.String... attributeNames)

Checks if the given attributes Map has all of the given attribute names. The values for the attribute names must be non-null and non-empty.

Parameters:

attributes - The attributes map.

attributeNames - The attribute names.

Returns:

True if the map contains all of the attribute names, false otherwise.

putDefaults

public static void putDefaults(java.util.Map<java.lang.String,java.lang.Object> map,
                               java.util.Map<java.lang.String,java.lang.Object> defaults)

Puts all of the values from the defaults map into the main map if they are absent. This is a good way to setup default values.

Parameters:

map - The main map.

defaults - The defaults map.

toListOfStrings

public static java.util.List<java.lang.String> toListOfStrings(java.lang.Object value)

Converts the object to a List of Strings. If the object is a List, this converts all non-null items to Strings and deletes null values. If it isn't a List, it returns a single element List with the value of object.toString().

Parameters:

value - The value to convert.

Returns:

The List of Strings.

toString

public static java.lang.String toString(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                        java.lang.String key)

Safely converts an attribute to a String.

Parameters:

attributes - The attributes.

key - The key of the attribute to convert.

Returns:

Null if the object is null, otherwise the result of calling toString.