Model (api-compiler 0.0.5 API)

java.lang.Object
- com.google.api.tools.framework.model.Element
- - com.google.api.tools.framework.model.Model

All Implemented Interfaces:

ConfigLocationResolver
```
public class Model
extends Element
implements ConfigLocationResolver
```
Model of an API service. Also manages processing pipelines and accumulation of diagnostics.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDiagIfNotSuppressed(java.lang.Object elementOrLocation, Diag diag)` Adds diagnosis to the model if it is not suppressed.
`void`	`addRoot(ProtoElement root)` Add a root element to the model.
`void`	`addSupressionDirective(Element elem, java.lang.String directive)` Adds a user-level suppression directive.
`static Model`	`create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto)` Creates an model where all protos in the descriptor are considered to be sources.
`static Model`	`create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto, java.lang.Iterable<java.lang.String> sources)` Creates a new model based on the given file descriptor set and list of source file names.
`static Model`	`create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto, java.lang.Iterable<java.lang.String> sources, java.lang.Iterable<java.lang.String> experiments, ExtensionPool extensionPool)` Creates a new model based on the given file descriptor, list of source file names and list of experiments to be enabled for the model.
`static Model`	`create(com.google.api.Service normalizedConfig)` Creates a model from a normalized service config, rather than from descriptor and .yaml files.
`static java.lang.String`	`diagPrefix(java.lang.String aspectName)` Returns a prefix to be used in diag messages for general errors and warnings.
`static java.lang.String`	`diagPrefixForLint(java.lang.String aspectName, java.lang.String ruleName)` Returns a prefix to be used in diag messages representing linter warnings.
`void`	`enableDiscoveryDocDerivation(boolean generateDerivedDiscovery)`
`void`	`enableExperiment(java.lang.String experiment)` Enables the given experiment (for testing).
`boolean`	`establishStage(com.google.inject.Key<?> key)` Establishes a processing stage.
`java.io.File`	`findDataFile(java.lang.String name)` Finds a file on the data path.
`java.lang.String`	`getApiV1VersionSuffix()` Gets API v1 version suffix.
`java.lang.Iterable<ConfigAspect>`	`getConfigAspects()` Returns the registered configuration aspects.
`int`	`getConfigVersion()` Returns the effective config version.
`java.lang.String`	`getControlEnvironment()` Returns the control environment string of this model.
`java.lang.String`	`getDataPath()` Returns a search path for data dependencies.
`java.util.Set<java.util.Set<java.lang.String>>`	`getDeclaredVisibilityCombinations()` Get a collection of declared visibility combinations.
`static int`	`getDefaultConfigVersion()` Returns the default config version.
`static int`	`getDevConfigVersion()` Returns the config version under development.
`DiagCollector`	`getDiagCollector()`
`com.google.common.collect.ImmutableList<ProtoFile>`	`getFiles()` Returns the list of (proto) files.
`java.lang.String`	`getFullName()` Returns a fully qualified name for the element.
`Location`	`getLocation()` Returns the location associated with this element.
`Location`	`getLocationInConfig(com.google.protobuf.Message message, java.lang.String fieldName)` Returns the service config file location of the given named field in the (sub)message.
`Location`	`getLocationOfRepeatedFieldInConfig(com.google.protobuf.Message message, java.lang.String fieldName, java.lang.Object elementKey)` Returns the service config file location of the given named field in the (sub)message.
`Model`	`getModel()` Returns the model associated with this element.
`com.google.api.Service`	`getNormalizedConfig()` Returns the normalized service config
`java.lang.Iterable<ProtoElement>`	`getRoots()` Get the roots collected for the model.
`Scoper`	`getScoper()` Gets the scoper used for this model.
`com.google.api.Service`	`getServiceConfig()` Returns the associated service config raw value.
`ConfigSource`	`getServiceConfigSource()` Returns the associated service config source.
`java.lang.String`	`getSimpleName()` Returns a simple name for the element.
`SymbolTable`	`getSymbolTable()` Returns the symbolTable
`java.util.Set<java.lang.String>`	`getVisibilityLabels()` Returns the visibility labels the caller wants to apply to this model.
`boolean`	`isExperimentEnabled(java.lang.String experiment)` Checks whether a given experiment is enabled.
`boolean`	`isPrivateService()` Returns true if the service is a private API, corp API, or on sandbox.googles.com non production environent.
`boolean`	`isSuppressedDiag(Diag diag, Element elem)` Checks whether the given diagnosis is suppressed for the given element.
`<E extends ProtoElement> java.lang.Iterable<E>`	`reachable(java.lang.Iterable<E> elems)` Returns the iterable scoped to the reachable elements.
`void`	`registerConfigAspect(ConfigAspect aspect)` Registers the configuration aspect with the model.
`Processor`	`registerProcessor(Processor processor)` Registers a stage processor.
`void`	`setApiV1VersionSuffix(java.lang.String value)` Sets API v1 version suffix in the model.
`void`	`setConfigs(java.lang.Iterable<com.google.protobuf.Message> configs)` Deprecated.
`void`	`setConfigSources(java.lang.Iterable<ConfigSource> configs)` Sets the service config based on a sequence of sources of heterogeneous types.
`void`	`setDataPath(java.lang.String dataPath)` Sets the data dependency search path.
`void`	`setDeclaredVisibilityCombinations(java.util.Set<java.util.Set<java.lang.String>> declaredVisibilityCombinations)` Set a collection of declared visibility combinations.
`void`	`setFiles(com.google.common.collect.ImmutableList<ProtoFile> files)` Set the list of (proto) files.
`void`	`setNormalizedConfig(com.google.api.Service normalizedConfig)`
`Scoper`	`setScoper(Scoper scoper)` Sets the scoper used for traversing this model.
`void`	`setServiceConfig(ConfigSource source)` Sets the service config from a config source.
`void`	`setServiceConfig(com.google.api.Service config)` Deprecated.
`void`	`setSymbolTable(SymbolTable symbolTable)` For setting the symbol table.
`java.util.Set<java.lang.String>`	`setVisibilityLabels(java.util.Set<java.lang.String> visibilityLabels)` Set visibility labels from the given list.
`void`	`setWarningFilter(java.lang.String aspectNamePattern)` Set a filter for warnings based on regular expression for aspect name.
`boolean`	`shouldDerivedDiscoveryDoc()` Returns true if the derived discovery doc should be generated and added into service config.
`void`	`suppressAllWarnings()` Shortcut for suppressing all warnings.

Methods inherited from class com.google.api.tools.framework.model.Element
addAttribute, getAttribute, getAttributeOrDefault, hasAttribute, putAttribute, removeAttribute

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static Model create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto,
                           java.lang.Iterable<java.lang.String> sources,
                           java.lang.Iterable<java.lang.String> experiments,
                           ExtensionPool extensionPool)
```
    Creates a new model based on the given file descriptor, list of source file names and list of experiments to be enabled for the model.
  - create
```
public static Model create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto,
                           java.lang.Iterable<java.lang.String> sources)
```
    Creates a new model based on the given file descriptor set and list of source file names. The file descriptor set is self-contained and contains the descriptors for the source files as well as for all dependencies.
  - create
```
public static Model create(com.google.protobuf.DescriptorProtos.FileDescriptorSet proto)
```
    Creates an model where all protos in the descriptor are considered to be sources.
  - create
```
public static Model create(com.google.api.Service normalizedConfig)
```
    Creates a model from a normalized service config, rather than from descriptor and .yaml files.
  - getDefaultConfigVersion
```
public static int getDefaultConfigVersion()
```
    Returns the default config version.
  - getDevConfigVersion
```
public static int getDevConfigVersion()
```
    Returns the config version under development.
  - getModel
```
public Model getModel()
```
    Description copied from class: Element
    
    Returns the model associated with this element.
    
    Specified by:
    
    getModel in class Element
  - getLocation
```
public Location getLocation()
```
    Description copied from class: Element
    
    Returns the location associated with this element.
    
    Specified by:
    
    getLocation in class Element
  - getFullName
```
public java.lang.String getFullName()
```
    Description copied from class: Element
    
    Returns a fully qualified name for the element.
    
    Specified by:
    
    getFullName in class Element
  - getSimpleName
```
public java.lang.String getSimpleName()
```
    Description copied from class: Element
    
    Returns a simple name for the element.
    
    Specified by:
    
    getSimpleName in class Element
  - getDiagCollector
```
public DiagCollector getDiagCollector()
```
  - getFiles
```
public com.google.common.collect.ImmutableList<ProtoFile> getFiles()
```
    Returns the list of (proto) files.
  - setFiles
```
public void setFiles(com.google.common.collect.ImmutableList<ProtoFile> files)
```
    Set the list of (proto) files.
  - getVisibilityLabels
```
@Nullable
public java.util.Set<java.lang.String> getVisibilityLabels()
```
    Returns the visibility labels the caller wants to apply to this model. If it is null, no visibility rules will be applied. If it is an empty set, only unrestricted elements will be visible.
  - setVisibilityLabels
```
public java.util.Set<java.lang.String> setVisibilityLabels(@Nullable
                                                           java.util.Set<java.lang.String> visibilityLabels)
```
    Set visibility labels from the given list. Validity of labels will be checked in later stages.
  - getDeclaredVisibilityCombinations
```
public java.util.Set<java.util.Set<java.lang.String>> getDeclaredVisibilityCombinations()
```
    Get a collection of declared visibility combinations.
  - setDeclaredVisibilityCombinations
```
public void setDeclaredVisibilityCombinations(java.util.Set<java.util.Set<java.lang.String>> declaredVisibilityCombinations)
```
    Set a collection of declared visibility combinations.
  - isExperimentEnabled
```
public boolean isExperimentEnabled(java.lang.String experiment)
```
    Checks whether a given experiment is enabled.
  - enableExperiment
```
public void enableExperiment(java.lang.String experiment)
```
    Enables the given experiment (for testing).
  - setApiV1VersionSuffix
```
public void setApiV1VersionSuffix(java.lang.String value)
```
    Sets API v1 version suffix in the model.
  - getApiV1VersionSuffix
```
public java.lang.String getApiV1VersionSuffix()
```
    Gets API v1 version suffix.
  - getSymbolTable
```
public SymbolTable getSymbolTable()
```
    Returns the symbolTable
  - setSymbolTable
```
public void setSymbolTable(SymbolTable symbolTable)
```
    For setting the symbol table.
  - addRoot
```
public void addRoot(ProtoElement root)
```
    Add a root element to the model. Root elements are collected during merging and used to compute the transitively reachable set of referenced elements.
  - getRoots
```
public java.lang.Iterable<ProtoElement> getRoots()
```
    Get the roots collected for the model.
  - setScoper
```
public Scoper setScoper(Scoper scoper)
```
    Sets the scoper used for traversing this model. Returns the previous scoper.
  - getScoper
```
public Scoper getScoper()
```
    Gets the scoper used for this model.
  - reachable
```
public <E extends ProtoElement> java.lang.Iterable<E> reachable(java.lang.Iterable<E> elems)
```
    Returns the iterable scoped to the reachable elements.
  - setServiceConfig
```
@Deprecated
public void setServiceConfig(com.google.api.Service config)
```
    Deprecated.
    
    Sets the service config from a proto.
  - setServiceConfig
```
public void setServiceConfig(ConfigSource source)
```
    Sets the service config from a config source.
  - setConfigSources
```
public void setConfigSources(java.lang.Iterable<ConfigSource> configs)
```
    Sets the service config based on a sequence of sources of heterogeneous types. Sources of the same type will be merged together, and those applicable to the framework will be attached to it.
  - setConfigs
```
@Deprecated
public void setConfigs(java.lang.Iterable<com.google.protobuf.Message> configs)
```
    Deprecated.
    
    Sets the service config based on a sequence of messages.
  - getServiceConfig
```
public com.google.api.Service getServiceConfig()
```
    Returns the associated service config raw value.
  - getServiceConfigSource
```
public ConfigSource getServiceConfigSource()
```
    Returns the associated service config source.
  - getConfigVersion
```
public int getConfigVersion()
```
    Returns the effective config version. Chooses the current default if the service config does not specify it.
  - getNormalizedConfig
```
public com.google.api.Service getNormalizedConfig()
```
    Returns the normalized service config
  - setNormalizedConfig
```
public void setNormalizedConfig(com.google.api.Service normalizedConfig)
```
  - diagPrefix
```
public static java.lang.String diagPrefix(java.lang.String aspectName)
```
    Returns a prefix to be used in diag messages for general errors and warnings.
  - diagPrefixForLint
```
public static java.lang.String diagPrefixForLint(java.lang.String aspectName,
                                                 java.lang.String ruleName)
```
    Returns a prefix to be used in diag messages representing linter warnings.
  - setWarningFilter
```
public void setWarningFilter(@Nullable
                             java.lang.String aspectNamePattern)
```
    Set a filter for warnings based on regular expression for aspect name. Only warnings containing the aspect name pattern are produced.
  - suppressAllWarnings
```
public void suppressAllWarnings()
```
    Shortcut for suppressing all warnings.
  - addSupressionDirective
```
public void addSupressionDirective(Element elem,
                                   java.lang.String directive)
```
    Adds a user-level suppression directive. The directive must be given in the form 'aspect-rule', or 'aspect-*' to match any rule. Is used in comments such as '(== suppress_warning http-* ==)' which will suppress all lint warnings generated by the http aspect.
  - isSuppressedDiag
```
public boolean isSuppressedDiag(Diag diag,
                                Element elem)
```
    Checks whether the given diagnosis is suppressed for the given element. This checks the suppression pattern for this element and all elements, inserting the model for global suppressions as a virtual parent.
  - getLocationInConfig
```
public Location getLocationInConfig(com.google.protobuf.Message message,
                                    java.lang.String fieldName)
```
    Returns the service config file location of the given named field in the (sub)message. Returns SimpleLocation.TOPLEVEL if the location is not known.
    
    Specified by:
    
    getLocationInConfig in interface ConfigLocationResolver
  - getLocationOfRepeatedFieldInConfig
```
public Location getLocationOfRepeatedFieldInConfig(com.google.protobuf.Message message,
                                                   java.lang.String fieldName,
                                                   java.lang.Object elementKey)
```
    Returns the service config file location of the given named field in the (sub)message. The key identifies the key of the map. For repeated fields, the element key is a zero-based index. Returns SimpleLocation.TOPLEVEL if the location is not known.
    
    Specified by:
    
    getLocationOfRepeatedFieldInConfig in interface ConfigLocationResolver
  - addDiagIfNotSuppressed
```
public void addDiagIfNotSuppressed(java.lang.Object elementOrLocation,
                                   Diag diag)
```
    Adds diagnosis to the model if it is not suppressed.
  - registerConfigAspect
```
public void registerConfigAspect(ConfigAspect aspect)
```
    Registers the configuration aspect with the model.
  - getConfigAspects
```
public java.lang.Iterable<ConfigAspect> getConfigAspects()
```
    Returns the registered configuration aspects.
  - registerProcessor
```
@Nullable
public Processor registerProcessor(Processor processor)
```
    Registers a stage processor. Returns the old processor or null if there wasn't one.
  - establishStage
```
public boolean establishStage(com.google.inject.Key<?> key)
```
    Establishes a processing stage. Runs the chain of all processors required to guarantee the given key is attached at the model. Returns true on success.
  - getDataPath
```
public java.lang.String getDataPath()
```
    Returns a search path for data dependencies. The path is a list of directories separated by File.pathSeparator.
  - setDataPath
```
public void setDataPath(java.lang.String dataPath)
```
    Sets the data dependency search path.
  - findDataFile
```
@Nullable
public java.io.File findDataFile(java.lang.String name)
```
    Finds a file on the data path. Returns null if not found.
  - getControlEnvironment
```
public java.lang.String getControlEnvironment()
```
    Returns the control environment string of this model.
  - isPrivateService
```
public boolean isPrivateService()
```
    Returns true if the service is a private API, corp API, or on sandbox.googles.com non production environent.
  - shouldDerivedDiscoveryDoc
```
public boolean shouldDerivedDiscoveryDoc()
```
    Returns true if the derived discovery doc should be generated and added into service config.
  - enableDiscoveryDocDerivation
```
public void enableDiscoveryDocDerivation(boolean generateDerivedDiscovery)
```

Class Model

Method Summary

Methods inherited from class com.google.api.tools.framework.model.Element

Methods inherited from class java.lang.Object

Method Detail

create

create

create

create

getDefaultConfigVersion

getDevConfigVersion

getModel

getLocation

getFullName

getSimpleName

getDiagCollector

getFiles

setFiles

getVisibilityLabels

setVisibilityLabels

getDeclaredVisibilityCombinations

setDeclaredVisibilityCombinations

isExperimentEnabled

enableExperiment

setApiV1VersionSuffix

getApiV1VersionSuffix

getSymbolTable

setSymbolTable

addRoot

getRoots

setScoper

getScoper

reachable

setServiceConfig

setServiceConfig

setConfigSources

setConfigs

getServiceConfig

getServiceConfigSource

getConfigVersion

getNormalizedConfig

setNormalizedConfig

diagPrefix

diagPrefixForLint

setWarningFilter

suppressAllWarnings

addSupressionDirective

isSuppressedDiag

getLocationInConfig

getLocationOfRepeatedFieldInConfig

addDiagIfNotSuppressed

registerConfigAspect

getConfigAspects

registerProcessor

establishStage

getDataPath

setDataPath

findDataFile

getControlEnvironment

isPrivateService

shouldDerivedDiscoveryDoc

enableDiscoveryDocDerivation