Functions (Magnolia Main Project (Parent) 6.1 API)

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.

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()

Constructors
Constructor and Description
`Functions()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Predicate<Resource>`	`always()` Deprecated. since 6.1 use concise lambdas with better parameter 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()` Deprecated. since 6.1 use static `Comparator.comparing(Function)` with `Resource.getPath()` method reference
`static Function<ResourceOrigin,Resource>`	`getByPath(String path)` Deprecated. since 6.1 use `ResourceOrigin.getByPath(String)` and lambdas
`static Function<Resource,Resource>`	`getParent()` Deprecated. since 6.1 use `Resource.getParent()` method reference
`static Function<Resource,String>`	`getPath()` Deprecated. since 6.1 use `Resource.getPath()` method reference
`static Function<ResourceOrigin,Resource>`	`getRoot()` Deprecated. since 6.1 use `ResourceOrigin.getRoot()` method reference
`static Predicate<ResourceOrigin>`	`hasPath(String path)` Deprecated. since 6.1 use `ResourceOrigin.hasPath(java.lang.String)` and lambdas
`static Predicate<Resource>`	`isDirectory()` Deprecated. since 6.1 use `Resource.isDirectory()` method reference
`static Predicate<Resource>`	`isFile()` Deprecated. since 6.1 use `Resource.isFile()` method reference
`static Predicate<Resource>`	`never()` Deprecated. since 6.1 use concise lambdas with better parameter name
`static Predicate<Resource>`	`pathEquals(CharSequence path)`
`static Predicate<Resource>`	`pathMatches(Pattern pattern)` Matches if the input `Resource`'s handle matches the given pattern.
`static Predicate<Resource>`	`pathMatches(Predicate<CharSequence> predicate)`
`static Predicate<Resource>`	`pathMatches(String pattern)`
`static 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
```
@Deprecated
public static Predicate<ResourceOrigin> hasPath(String path)
```
    Deprecated. since 6.1 use ResourceOrigin.hasPath(java.lang.String) and lambdas
  - pathEquals
```
public static Predicate<Resource> pathEquals(CharSequence path)
```
  - pathStartsWith
```
public static Predicate<Resource> pathStartsWith(CharSequence pathPrefix)
```
  - pathMatches
```
public static Predicate<Resource> pathMatches(String pattern)
```
    See Also:
    
    pathMatches(Pattern), pathMatches(Predicate)
  - pathMatches
```
public static 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 Predicate<Resource> pathMatches(Predicate<CharSequence> predicate)
```
    See Also:
    
    pathMatches(String), pathMatches(Pattern)
  - isDirectory
```
@Deprecated
public static Predicate<Resource> isDirectory()
```
    Deprecated. since 6.1 use Resource.isDirectory() method reference
  - isFile
```
@Deprecated
public static Predicate<Resource> isFile()
```
    Deprecated. since 6.1 use Resource.isFile() method reference
  - always
```
@Deprecated
public static Predicate<Resource> always()
```
    Deprecated. since 6.1 use concise lambdas with better parameter name
    
    Convenient Predicate which simply returns true, avoids verbose type parameter declaration and provides a (debatably) better name.
  - never
```
@Deprecated
public static Predicate<Resource> never()
```
    Deprecated. since 6.1 use concise lambdas with better parameter name
    
    Convenient Predicate which simply returns false, avoids verbose type parameter declaration, and provides a (debatably) better name.
  - getByPath
```
@Deprecated
public static Function<ResourceOrigin,Resource> getByPath(String path)
```
    Deprecated. since 6.1 use ResourceOrigin.getByPath(String) and lambdas
    
    Convenient Predicate which simply returns true, avoids verbose type parameter declaration and provides a (debatably) better name.
  - getRoot
```
@Deprecated
public static Function<ResourceOrigin,Resource> getRoot()
```
    Deprecated. since 6.1 use ResourceOrigin.getRoot() method reference
  - getPath
```
@Deprecated
public static Function<Resource,String> getPath()
```
    Deprecated. since 6.1 use Resource.getPath() method reference
  - getParent
```
@Deprecated
public static Function<Resource,Resource> getParent()
```
    Deprecated. since 6.1 use Resource.getParent() method reference
  - 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
```
@Deprecated
public static <R extends Resource> Comparator<R> compareByHandle()
```
    Deprecated. since 6.1 use static Comparator.comparing(Function) with Resource.getPath() method reference

Class Functions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Functions

Method Detail

hasPath

pathEquals

pathStartsWith

pathMatches

pathMatches

pathMatches

isDirectory

isFile

always

never

getByPath

getRoot

getPath

getParent

collector

collector

compareByHandle