Package com.atlassian.plugin.webresource.impl.discovery

Class Found

java.lang.Object

com.atlassian.plugin.webresource.impl.discovery.Found

public class Found
extends Object

Represents the result of walking the dependency graph via BundleWalker, where every item is in is in topological sort order. The items captured will vary based on how the graph walk was configured in BundleFinder or BundleWalker.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Found.Item	Tuple of a Requestable key and its contribution Found.State to the response for a client request.

Field Summary

Fields

Modifier and Type	Field	Description
static final Found	EMPTY

Constructor Summary

Constructors

Constructor	Description
Found(List<Found.Item> items, List<String> reducedInclusions, Set<String> reducedExclusions)

Method Summary

Modifier and Type	Method	Description
List<String>	getAll()
List<String>	getFound()
Set<String>	getReducedExclusions()
List<String>	getReducedInclusions()
List<String>	getSkipped()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final Found EMPTY

Constructor Details

Found

public Found(List<Found.Item> items,
 List<String> reducedInclusions,
 Set<String> reducedExclusions)

Method Details

getFound

public List<String> getFound()

Returns:

a list of Requestable keys whose content should be served to the client.

getSkipped

public List<String> getSkipped()

Returns:

a list of Requestable keys that failed a deep filter test while traversing the graph (such as a UrlReadingCondition returning false) and should not be served to the client. Note that these are the exact items that failed a predicate test. Any child items would be ignored by the graph walk. If you need a complete list that includes subtrees of skipped items, configure BundleFinder.onDeepFilterFail(PredicateFailStrategy) to continue when a deep filter fails.

getAll

public List<String> getAll()

Returns:

all Requestable keys discovered while performing this graph traversal. The list will include all skipped items, and may include ignored subtrees depending on how BundleFinder.onDeepFilterFail(PredicateFailStrategy) was configured.

getReducedInclusions

public List<String> getReducedInclusions()

Returns:

the minimal set of graph entry points required to discover all the getFound() items after omitting subtrees discoverable via getReducedExclusions(). Can be used to minimise encoding cost when expressing the graph query and avoid redundant graph walks.

getReducedExclusions

public Set<String> getReducedExclusions()

Returns:

the minimal set of graph entry points required to avoid serving content the client should not be given. Can be used to minimise encoding cost when expressing the graph query and avoid redundant graph walks.