com.google.api.tools.framework.model

Class ConfigSource

java.lang.Object

com.google.api.tools.framework.model.ConfigSource

public class ConfigSource
extends java.lang.Object

Represents a configuration source. Maintains information about the configuration message, the fields which have been explicitly set in the configuration, and source locations. Also supports merging of configurations preserving above information, and allowing to override default values (which standard proto3 merging semantics does not support).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigSource.BuildAction An interface which represents a build action performed on a builder for a sub-configuration.
static class	ConfigSource.Builder Represents a builder for a configuration message.

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Message	getConfig() Returns the config message.
Location	getLocation(com.google.protobuf.Message message, java.lang.String fieldName, java.lang.Object elementKey) Returns the location of the given named field in the (sub)message, with optional element key for maps or repeated fields.
static ConfigSource.Builder	newBuilder(com.google.protobuf.Message defaultInstance) Constructs a new empty builder, based on the given default instance for the underlying config message.
ConfigSource.Builder	toBuilder() Constructs a builder from this configuration message.

Methods inherited from class java.lang.Object

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

Method Detail

getConfig

public com.google.protobuf.Message getConfig()

Returns the config message.

getLocation

public Location getLocation(com.google.protobuf.Message message,
                            java.lang.String fieldName,
                            @Nullable
                            java.lang.Object elementKey)

Returns the location of the given named field in the (sub)message, with optional element key for maps or repeated fields. For repeated fields, the element key is a zero-based index. Returns SimpleLocation.UNKNOWN if the location is not known.

toBuilder

public ConfigSource.Builder toBuilder()

Constructs a builder from this configuration message.

newBuilder

public static ConfigSource.Builder newBuilder(com.google.protobuf.Message defaultInstance)

Constructs a new empty builder, based on the given default instance for the underlying config message.

An initialized message can also be passed, however, no source location tracking will happen for it.