de.vandermeer.skb.categories

Interface IsPath

All Superinterfaces:

CategoryHas, CategoryIs, CategoryWithValue, HasDescription

public interface IsPath
extends CategoryIs, CategoryWithValue, HasDescription

Category of objects that represent a path.

Version:

v0.0.4 build 150619 (19-Jun-15) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields inherited from interface de.vandermeer.skb.categories.CategoryWithValue

comparator

Method Summary

Modifier and Type	Method and Description
String	_value() Returns the value of an IS category.
static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,org.apache.commons.lang3.text.StrBuilder>	ADD_ROOT(String separator) Returns a transformer that adds the separator in front of a path (if path does not start already with separator)
static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,org.apache.commons.lang3.text.StrBuilder>	CLEAN_PATH(String separator) Returns a transformer that removes all excessive elements (such as double separators).
static IsPath	create() Returns a new generic IsPath object with a default preset path (immutable).
static IsPath	create(Object path) Returns a new generic IsPath object with defined path and a default description (immutable).
static IsPath	create(Object path, String description) Returns a new generic IsPath object with a path (immutable).
static org.apache.commons.lang3.text.StrBuilder	forMaxDepth(org.apache.commons.lang3.text.StrBuilder fqpn, int maxDepth, String separator) Checks if the FQPN is less or equal to a maximum depth
static Collection<String>	GET_SUB_PATHS(String separator, Object fqpn, Collection<String> coll) Returns a collection with the names of all children of a given path from a given collection of paths
static Predicate<String>	IS_SUB_PATH_OF(String separator, Object fqpn) Returns a predicate that evaluates if a given path is a sub path using a specified path separator.
static Predicate<Object>	IS_VALID_PATH_VALUE(String separator) Returns a predicate that validates a path value.
static <A,B> de.vandermeer.skb.base.Skb_Transformer<org.antlr.v4.runtime.misc.Pair<A,B>,org.apache.commons.lang3.text.StrBuilder>	JOIN_PATH_ELEMENTS(String separator, Boolean doClean, Boolean setRoot) Returns a transformer that combines a pair of path information into a single path.
static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,List<String>>	PATH_TO_ARRAY_OF_PATHS(String separator, Boolean autoRootArray) Returns a transformer that takes a path (as StrBuilder) and returns a list of all path contained.
static de.vandermeer.skb.base.Skb_Transformer<Object,Integer>	PATH_TO_LEVELS(String separator) Returns a transformer that calculates the levels in a path.
default String	path() Returns the path

Methods inherited from interface de.vandermeer.skb.categories.HasDescription

getDescription

Methods inherited from interface de.vandermeer.skb.categories.CategoryWithValue

CAT_TO_VALUE, CAT_TO_VALUESTRING, GET_VALUE, GET_VALUESTRING, toLog

Method Detail

path

default String path()

Returns the path

Returns:

path

_value

String _value()

Description copied from interface: CategoryWithValue

Returns the value of an IS category.

Specified by:

_value in interface CategoryWithValue

Returns:

value of an IS category

create

static IsPath create(Object path,
                     String description)

Returns a new generic IsPath object with a path (immutable).

Parameters:

path - the object's path

description - a description for the new path

Returns:

new IsPath object with a set path

create

static IsPath create(Object path)

Returns a new generic IsPath object with defined path and a default description (immutable).

Parameters:

path - the object's path

Returns:

new IsPath object with a default description

create

static IsPath create()

Returns a new generic IsPath object with a default preset path (immutable).

Returns:

new IsPath object with a default path

IS_VALID_PATH_VALUE

static Predicate<Object> IS_VALID_PATH_VALUE(String separator)

Returns a predicate that validates a path value. The path value is evaluated as FQPN string in terms of:

• is of length one and contains only the separator
• or fulfils all of the following criteria
  • is not empty (null, "" or only white spaces
  • does start with the separator, e.g. '/'
  • does not contain any sequence of separators, e.g. '//'
  • does not end with the separator

Parameters:

separator - path separator

Returns:

predicate that validates a path value with return of -1 if FQPN not valid, 0 if equal to separator, >0 otherwise

IS_SUB_PATH_OF

static Predicate<String> IS_SUB_PATH_OF(String separator,
                                        Object fqpn)

Returns a predicate that evaluates if a given path is a sub path using a specified path separator. Sub path here means that the path given to the predicate as a string is a child of the given FQPN.

Parameters:

separator - path separator

fqpn - original path as FQPN

Returns:

predicate that tests for sub paths

PATH_TO_LEVELS

static de.vandermeer.skb.base.Skb_Transformer<Object,Integer> PATH_TO_LEVELS(String separator)

Returns a transformer that calculates the levels in a path. The level is calculated for a given FQPN as follows:

• -1 if the FQPN is not valid
• 0 if the FQPN is valid, of size one and contains (only) a single separator
• >0 if the FQPN is valid (number is effectively the count of separators in the FQPN)

Parameters:

separator - path separator to be used

Returns:

transformer for path-level calculations

GET_SUB_PATHS

static Collection<String> GET_SUB_PATHS(String separator,
                                        Object fqpn,
                                        Collection<String> coll)

Returns a collection with the names of all children of a given path from a given collection of paths

Parameters:

separator - path separator to use

fqpn - name of the path

coll - all paths that are children of the given path

Returns:

collection of paths that are sub paths of the given fqpn

PATH_TO_ARRAY_OF_PATHS

static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,List<String>> PATH_TO_ARRAY_OF_PATHS(String separator,
                                                                                                                            Boolean autoRootArray)

Returns a transformer that takes a path (as StrBuilder) and returns a list of all path contained. For instance, if the FQPN built for path and name is "/a/b/c/d", then the returned array will be [a, a/b, a/b/c, a/b/c/d] (assuming that the separator is '/'). The resulting array will have a root node added if autoRoot is activated.

Parameters:

separator - path separator

autoRootArray - add root node if true, add nothing if false

Returns:

a transformer that takes a path and returns a list of all contained paths, or an empty list

CLEAN_PATH

static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,org.apache.commons.lang3.text.StrBuilder> CLEAN_PATH(String separator)

Returns a transformer that removes all excessive elements (such as double separators).

Parameters:

separator - path separator

Returns:

a transformer that returns a FQPN that does not contain excessive separators, but can be invalid otherwise

ADD_ROOT

static de.vandermeer.skb.base.Skb_Transformer<org.apache.commons.lang3.text.StrBuilder,org.apache.commons.lang3.text.StrBuilder> ADD_ROOT(String separator)

Returns a transformer that adds the separator in front of a path (if path does not start already with separator)

Parameters:

separator - path separator

Returns:

a transformer that returns an FQPN that starts with a separator, but can be invalid otherwise

JOIN_PATH_ELEMENTS

static <A,B> de.vandermeer.skb.base.Skb_Transformer<org.antlr.v4.runtime.misc.Pair<A,B>,org.apache.commons.lang3.text.StrBuilder> JOIN_PATH_ELEMENTS(String separator,
                                                                                                                                                     Boolean doClean,
                                                                                                                                                     Boolean setRoot)

Returns a transformer that combines a pair of path information into a single path. If the A in the pair is null, then null will be returned. In all other cases a path is returned. Path and name are processed as follows:

• if it is null, nothing happens
• if it is an instance of Object[], all elements of the array are joined using the separator
• if it is an instance of Iterator, all elements the iterator returns are joined using the separator
• if it is an instance of Iterable, all elements the iterable returns are joined using the separator
• in all other case the object's toString() method is used as path/name components

The returned FQPN can be valid or invalid, depending on the doClean and setRoot flags. If both flags are set true, the returned FQPN will be a valid one. If either of them is set to false, the FQPN might be valid depending on path/name components.

Type Parameters:

A - left type of pair

B - right type of pair

Parameters:

separator - path separator

doClean - clean the final path (if true)

setRoot - set a root separator on the final path (if true)

Returns:

transformer that combines objects to a path

forMaxDepth

static org.apache.commons.lang3.text.StrBuilder forMaxDepth(org.apache.commons.lang3.text.StrBuilder fqpn,
                                                            int maxDepth,
                                                            String separator)

Checks if the FQPN is less or equal to a maximum depth

Parameters:

fqpn - FQPN for testing

maxDepth - maximum depth to test for, set to -1 for no test

separator - path separator

Returns:

FQPN if maximum depth is -1 or if level of FQPN is less or equal to given maximum depth, null otherwise (e.g. maximum depth < -2, FQPN not valid)