com.google.api.tools.framework.model

Interface Scoper

All Known Implementing Classes:

ScoperImpl

public interface Scoper

A scoper is an object which allows to traverse the model only looking at elements which are 'in scope'.

Field Summary

Fields

Modifier and Type	Field and Description
static Scoper	UNRESTRICTED An unrestricted scoper with all elements in scope.

Method Summary

Modifier and Type	Method and Description
<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.
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.

Field Detail

UNRESTRICTED

static final Scoper UNRESTRICTED

An unrestricted scoper with all elements in scope.

Method Detail

isReachable

boolean isReachable(ProtoElement elem)

Returns true if the element is reachable with this scoper.

filter

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

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

hasUnreachableDescendants

boolean hasUnreachableDescendants(ProtoElement elem)

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.

restrict

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. This may produce errors if scoping rules are violated, or if the visibility label combination is not available.

restrict

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. This may produce errors if scoping rules are violated. The passed errorContext is used in error messages to identify the source of the error.