com.facebook.buck.core.config

Interface ConfigView<T>

Type Parameters:

T - Config type.

All Known Implementing Classes:

ActionGraphConfig, AdbConfig, AliasConfig, AppleConfig, ArtifactCacheBuckConfig, BuildBuckConfig, BuildReportConfig, CachingBuildEngineBuckConfig, ChromeTraceBuckConfig, CleanCommandBuckConfig, CliConfig, ConfigIgnoredByDaemon, CounterBuckConfig, DepsAwareExecutorConfig, DoctorConfig, DotnetBuckConfig, ErrorHandlingBuckConfig, FixBuckConfig, InferConfig, JavaBuckConfig, KotlinBuckConfig, LogBuckConfig, ModernBuildRuleConfig, ParserConfig, RemoteExecutionConfig, ResourcesConfig, RuleAnalysisConfig, RuleKeyConfig, SandboxConfig, ScribeEventListenerConfig, SwiftBuckConfig, TestBuckConfig, ToolConfig

public interface ConfigView<T>

A view of a particular config class.

A config class may implement extra state and accessors beyond the bare Config. ConfigViews provides domain-specific accessors to Config values.

ConfigViews should be defined following this pattern.

  @BuckStyleValue
  abstract class FooConfigView implements ConfigView {
    // Additional accessors.

    static FooConfigView of(T delegate) {
      return ImmutableFooConfigView.of(delegate);
    }
  }
 

Config views should also not declare any additional non-derived immutable fields if it's to be used with ConfigViewCache. As the cache assumes one-to-one correspondence with the main config instance, it uses the generated factory FooConfigView.of(T delegate) to instantiate the view.

Method Summary

Modifier and Type	Method and Description
T	getDelegate()

Method Detail

getDelegate

T getDelegate()