info.magnolia.resourceloader.util

Class Functions

java.lang.Object

info.magnolia.resourceloader.util.Functions

public class Functions
extends Object

Functional-ish Function, Predicate and Comparator implementations that are useful when working with ResourceOrigin and Resource, and some more useful ones that had no better place for now. They are used to implement LayeredResourceOrigin, but could be reused for filtering and other purposes. // TODO consistent naming -- handle or path Most of this would be completely redundant with Java 8, since all these do is delegate to a given method of the input object: simple method references as lambdas would suffice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Functions.CollectorFunction<T> A simple Function which aggregates arguments from all its invocations.

Constructor Summary

Constructors

Constructor and Description
Functions()

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.common.base.Predicate<Resource>	always() Convenient Predicate which simply delegates to Predicates.alwaysTrue(), avoids verbose type parameter declaration and provides a (debatably) better name.
static <T> Functions.CollectorFunction<T>	collector() This Function simply collects all input into a new collection.
static <T> Functions.CollectorFunction<T>	collector(Collection<T> target) This Function simply collects all input into the given target collection.
static <R extends Resource> Comparator<R>	compareByHandle()
static com.google.common.base.Function<ResourceOrigin,Resource>	getByPath(String path)
static com.google.common.base.Function<Resource,Resource>	getParent()
static com.google.common.base.Function<Resource,String>	getPath()
static com.google.common.base.Function<ResourceOrigin,Resource>	getRoot()
static com.google.common.base.Predicate<ResourceOrigin>	hasPath(String path)
static com.google.common.base.Predicate<Resource>	isDirectory()
static com.google.common.base.Predicate<Resource>	isFile()
static com.google.common.base.Predicate<Resource>	never() Convenient Predicate which simply delegates to Predicates.alwaysFalse(), avoids verbose type parameter declaration, and provides a (debatably) better name.
static com.google.common.base.Predicate<Resource>	pathEquals(CharSequence path)
static com.google.common.base.Predicate<Resource>	pathMatches(Pattern pattern) Matches if the input Resource's handle matches the given pattern.
static com.google.common.base.Predicate<Resource>	pathMatches(com.google.common.base.Predicate<CharSequence> predicate)
static com.google.common.base.Predicate<Resource>	pathMatches(String pattern)
static com.google.common.base.Predicate<Resource>	pathStartsWith(CharSequence pathPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

Functions

public Functions()

Method Detail

hasPath

public static com.google.common.base.Predicate<ResourceOrigin> hasPath(String path)

pathEquals

public static com.google.common.base.Predicate<Resource> pathEquals(CharSequence path)

pathStartsWith

public static com.google.common.base.Predicate<Resource> pathStartsWith(CharSequence pathPrefix)

pathMatches

public static com.google.common.base.Predicate<Resource> pathMatches(String pattern)

See Also:

pathMatches(Pattern), pathMatches(Predicate)

pathMatches

public static com.google.common.base.Predicate<Resource> pathMatches(Pattern pattern)

Matches if the input Resource's handle matches the given pattern. Matches incomplete strings by default, e.g /bar pattern will match the /foo/bar/qux resource, while ^/bar won't.

See Also:

pathMatches(String), pathMatches(Predicate)

pathMatches

public static com.google.common.base.Predicate<Resource> pathMatches(com.google.common.base.Predicate<CharSequence> predicate)

See Also:

pathMatches(String), pathMatches(Pattern)

isDirectory

public static com.google.common.base.Predicate<Resource> isDirectory()

isFile

public static com.google.common.base.Predicate<Resource> isFile()

always

public static com.google.common.base.Predicate<Resource> always()

Convenient Predicate which simply delegates to Predicates.alwaysTrue(), avoids verbose type parameter declaration and provides a (debatably) better name.

never

public static com.google.common.base.Predicate<Resource> never()

Convenient Predicate which simply delegates to Predicates.alwaysFalse(), avoids verbose type parameter declaration, and provides a (debatably) better name.

getByPath

public static com.google.common.base.Function<ResourceOrigin,Resource> getByPath(String path)

getRoot

public static com.google.common.base.Function<ResourceOrigin,Resource> getRoot()

getPath

public static com.google.common.base.Function<Resource,String> getPath()

getParent

public static com.google.common.base.Function<Resource,Resource> getParent()

collector

public static <T> Functions.CollectorFunction<T> collector(Collection<T> target)

This Function simply collects all input into the given target collection. It adds elements to the given target collection, but it can also be retrieved with Functions.CollectorFunction.getTarget()

collector

public static <T> Functions.CollectorFunction<T> collector()

This Function simply collects all input into a new collection. The collection can be retrieved with Functions.CollectorFunction.getTarget()

compareByHandle

public static <R extends Resource> Comparator<R> compareByHandle()