com.google.api.tools.framework.aspects.visibility.model

Class ScoperImpl

java.lang.Object

com.google.api.tools.framework.aspects.visibility.model.ScoperImpl

All Implemented Interfaces:

Scoper

public abstract class ScoperImpl
extends java.lang.Object
implements Scoper

Implementation of scopers. Applications use the factory methods, or subclass and override the inScope(ProtoElement) method of this class. The class computes the transitive closure of reachable elements from a given set of roots and uses it to implement the Scoper interface. During construction of a scoper, errors may be produced if scoping rules are violated. See the documentation of API visibility for the rules.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<ProtoElement,java.lang.String>	reasonForUnreachable

Fields inherited from interface com.google.api.tools.framework.model.Scoper

UNRESTRICTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScoperImpl(java.lang.Iterable<? extends ProtoElement> roots, java.lang.String errorContext) Constructs a scoper for the given roots.

Method Summary

Modifier and Type	Method and Description
static Scoper	create(java.lang.Iterable<ProtoElement> roots) Returns a scoper which restricts a model to the elements reachable via the given roots.
<E extends ProtoElement> java.lang.Iterable<E>	filter(java.lang.Iterable<E> elems) Filters the given iterable to the elements reachable with this scoper.
boolean	hasUnreachableDescendants(ProtoElement elem) Returns true if the given message or enum type has any hidden, non-reachable descendants, e.g.
abstract boolean	inScope(ProtoElement elem) Determines whether the given proto element is in scope.
boolean	isReachable(ProtoElement elem) Returns true if the element is reachable with this scoper.
Scoper	restrict(Model model, java.util.Set<java.lang.String> visibilityLabels) Returns a scoper which restricts a model to the elements reachable with given visibility labels applied.
Scoper	restrict(com.google.common.base.Predicate<ProtoElement> predicate, java.lang.String errorContext) Returns a scoper which refines restrictions on this scoper using the predicate.

Methods inherited from class java.lang.Object

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

Field Detail

reasonForUnreachable

protected final java.util.Map<ProtoElement,java.lang.String> reasonForUnreachable

Constructor Detail

ScoperImpl

protected ScoperImpl(java.lang.Iterable<? extends ProtoElement> roots,
                     java.lang.String errorContext)

Constructs a scoper for the given roots. Computes reachability transitively based on the inScope(ProtoElement) predicate. This may produced errors in the case elements are not in scope which are required by in-scope ones, e.g. request/response messages of methods are not in scope which are used by in-scope methods.

Method Detail

create

public static Scoper create(java.lang.Iterable<ProtoElement> roots)

Returns a scoper which restricts a model to the elements reachable via the given roots.

inScope

public abstract boolean inScope(ProtoElement elem)

Determines whether the given proto element is in scope. This method must be implemented by sub-classes.

isReachable

public boolean isReachable(ProtoElement elem)

Description copied from interface: Scoper

Returns true if the element is reachable with this scoper.

Specified by:

isReachable in interface Scoper

hasUnreachableDescendants

public boolean hasUnreachableDescendants(ProtoElement elem)

Description copied from interface: Scoper

Returns true if the given message or enum type has any hidden, non-reachable descendants, e.g. fields which are not reachable, or which have types which have non-reachable elements.

Specified by:

hasUnreachableDescendants in interface Scoper

filter

public <E extends ProtoElement> java.lang.Iterable<E> filter(java.lang.Iterable<E> elems)

Description copied from interface: Scoper

Filters the given iterable to the elements reachable with this scoper.

Specified by:

filter in interface Scoper

restrict

public Scoper restrict(Model model,
                       java.util.Set<java.lang.String> visibilityLabels)

Description copied from interface: Scoper

Returns a scoper which restricts a model to the elements reachable with given visibility labels applied. This may produce errors if scoping rules are violated, or if the visibility label combination is not available.

Specified by:

restrict in interface Scoper

restrict

public Scoper restrict(com.google.common.base.Predicate<ProtoElement> predicate,
                       java.lang.String errorContext)

Description copied from interface: Scoper

Returns a scoper which refines restrictions on this scoper using the predicate. This may produce errors if scoping rules are violated. The passed errorContext is used in error messages to identify the source of the error.

Specified by:

restrict in interface Scoper