Interface NBPathsAPI.DoSearch

All Known Subinterfaces:

NBPathsAPI.Facets, NBPathsAPI.GetExtensions, NBPathsAPI.GetPathname, NBPathsAPI.GetPrefixes

All Known Implementing Classes:

NBIO

Enclosing interface:

NBPathsAPI

public static interface NBPathsAPI.DoSearch

Method Summary

Modifier and Type	Method	Description
Optional<Content<?>>	first()	Return the result of resolving the resource.
List<Content<?>>	list()	Provide a list of all matching content that was matched by the search qualifiers
Content<?>	one()	Find exactly one source of content under the search parameters given.
List<Path>	relativeTo(String... base)	Return a list of paths which are comprised of the relative part once the provided base has been removed from the front.
List<List<Content<?>>>	resolveEach()	Return the result of resolving each of the resource names given.

Method Details

first

Optional<Content<?>> first()

Return the result of resolving the resource.

Returns:

an optional Content<?> element.

resolveEach

List<List<Content<?>>> resolveEach()

Return the result of resolving each of the resource names given. This has the same semantics of first(), except that it returns a result pair-wise for each name given.

Returns:

A list of optional Content<?> elements.

list

List<Content<?>> list()

Provide a list of all matching content that was matched by the search qualifiers

Returns:

a list of content

relativeTo

List<Path> relativeTo(String... base)

Return a list of paths which are comprised of the relative part once the provided base has been removed from the front. This is done per content item within the direct filesystem the path belongs to.

Parameters:

base - The root path elements to remove

Returns:

Relative paths

one

Content<?> one()

Find exactly one source of content under the search parameters given. It is an error if you find none, or more than one.

Returns:

An optional content element.