ImmutableModuleConfiguration (Protostuff Compiler

java.lang.Object
- io.protostuff.compiler.model.ImmutableModuleConfiguration

All Implemented Interfaces:: ModuleConfiguration

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","ModuleConfiguration"})
 @Immutable
public final class ImmutableModuleConfiguration
extends Object
implements ModuleConfiguration

Immutable implementation of ModuleConfiguration.

Use builder to create immutable instances: ImmutableModuleConfiguration.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableModuleConfiguration.Builder
Builds instances of ImmutableModuleConfiguration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableModuleConfiguration.Builder` Builds instances of `ImmutableModuleConfiguration`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableModuleConfiguration.Builder`	`builder()` Creates builder for `ImmutableModuleConfiguration`.
`static ImmutableModuleConfiguration`	`copyOf(ModuleConfiguration instance)` Creates immutable copy of `ModuleConfiguration`.
`boolean`	`equals(Object another)` This instance is equal to instances of `ImmutableModuleConfiguration` with equal attribute values.
`String`	`getGenerator()` Generator used to compile proto files.
`com.google.common.collect.ImmutableList<Path>`	`getIncludePaths()` List of "include" folders used to search for proto files.
`String`	`getName()` Module name.
`com.google.common.collect.ImmutableMap<String,String>`	`getOptions()` Map of custom settings passed to the generator.
`String`	`getOutput()` Output directory.
`com.google.common.collect.ImmutableList<String>`	`getProtoFiles()` List of proto files to compile.
`int`	`hashCode()` Computes hash code from attributes: `name`, `includePaths`, `protoFiles`, `generator`, `output`, `options`.
`String`	`toString()` Prints immutable value `ModuleConfiguration...` with attribute values, excluding any non-generated and auxiliary attributes.
`ImmutableModuleConfiguration`	`withGenerator(String value)` Copy current immutable object by setting value for `generator`.
`ImmutableModuleConfiguration`	`withIncludePaths(Iterable<? extends Path> elements)` Copy current immutable object with elements that replace content of `includePaths`.
`ImmutableModuleConfiguration`	`withIncludePaths(Path... elements)` Copy current immutable object with elements that replace content of `includePaths`.
`ImmutableModuleConfiguration`	`withName(String value)` Copy current immutable object by setting value for `name`.
`ImmutableModuleConfiguration`	`withOptions(Map<String,? extends String> entries)` Copy current immutable object by replacing `options` map with specified map.
`ImmutableModuleConfiguration`	`withOutput(String value)` Copy current immutable object by setting value for `output`.
`ImmutableModuleConfiguration`	`withProtoFiles(Iterable<String> elements)` Copy current immutable object with elements that replace content of `protoFiles`.
`ImmutableModuleConfiguration`	`withProtoFiles(String... elements)` Copy current immutable object with elements that replace content of `protoFiles`.

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

- Method Detail
  - getName
```
public String getName()
```
    Module name.
    
    Specified by:
    
    getName in interface ModuleConfiguration
  - getIncludePaths
```
public com.google.common.collect.ImmutableList<Path> getIncludePaths()
```
    List of "include" folders used to search for proto files.
    
    Specified by:
    
    getIncludePaths in interface ModuleConfiguration
  - getProtoFiles
```
public com.google.common.collect.ImmutableList<String> getProtoFiles()
```
    List of proto files to compile.
    
    Specified by:
    
    getProtoFiles in interface ModuleConfiguration
  - getGenerator
```
public String getGenerator()
```
    Generator used to compile proto files. Currently following generators are supported:
    - java - produces Java source code that uses protostuff runtime;
    - html - produces HTML documentation;
    - st4 - generic generator, you should provide custom template (StringTemplate 4) using getOptions().
    Specified by:
    
    getGenerator in interface ModuleConfiguration
  - getOutput
```
public String getOutput()
```
    Output directory.
    
    Specified by:
    
    getOutput in interface ModuleConfiguration
  - getOptions
```
public com.google.common.collect.ImmutableMap<String,String> getOptions()
```
    Map of custom settings passed to the generator.
    
    Specified by:
    
    getOptions in interface ModuleConfiguration
  - withName
```
public final ImmutableModuleConfiguration withName(String value)
```
    Copy current immutable object by setting value for name. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for name
    
    Returns:
    
    modified copy of the this object
  - withIncludePaths
```
public final ImmutableModuleConfiguration withIncludePaths(Path... elements)
```
    Copy current immutable object with elements that replace content of includePaths.
    
    Parameters:
    
    elements - elements to set
    
    Returns:
    
    modified copy of this object
  - withIncludePaths
```
public final ImmutableModuleConfiguration withIncludePaths(Iterable<? extends Path> elements)
```
    Copy current immutable object with elements that replace content of includePaths. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - iterable of includePaths elements to set
    
    Returns:
    
    modified copy of this object
  - withProtoFiles
```
public final ImmutableModuleConfiguration withProtoFiles(String... elements)
```
    Copy current immutable object with elements that replace content of protoFiles.
    
    Parameters:
    
    elements - elements to set
    
    Returns:
    
    modified copy of this object
  - withProtoFiles
```
public final ImmutableModuleConfiguration withProtoFiles(Iterable<String> elements)
```
    Copy current immutable object with elements that replace content of protoFiles. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - iterable of protoFiles elements to set
    
    Returns:
    
    modified copy of this object
  - withGenerator
```
public final ImmutableModuleConfiguration withGenerator(String value)
```
    Copy current immutable object by setting value for generator. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for generator
    
    Returns:
    
    modified copy of the this object
  - withOutput
```
public final ImmutableModuleConfiguration withOutput(String value)
```
    Copy current immutable object by setting value for output. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for output
    
    Returns:
    
    modified copy of the this object
  - withOptions
```
public final ImmutableModuleConfiguration withOptions(Map<String,? extends String> entries)
```
    Copy current immutable object by replacing options map with specified map. Nulls are not permitted as keys or values. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    entries - to be added to options map
    
    Returns:
    
    modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to instances of ImmutableModuleConfiguration with equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes hash code from attributes: name, includePaths, protoFiles, generator, output, options.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints immutable value ModuleConfiguration... with attribute values, excluding any non-generated and auxiliary attributes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of value
  - copyOf
```
public static ImmutableModuleConfiguration copyOf(ModuleConfiguration instance)
```
    Creates immutable copy of ModuleConfiguration. Uses accessors to get values to initialize immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - instance to copy
    
    Returns:
    
    copied immutable ModuleConfiguration instance
  - builder
```
public static ImmutableModuleConfiguration.Builder builder()
```
    Creates builder for ImmutableModuleConfiguration.
    
    Returns:
    
    new ImmutableModuleConfiguration builder

Class ImmutableModuleConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getIncludePaths

getProtoFiles

getGenerator

getOutput

getOptions

withName

withIncludePaths

withIncludePaths

withProtoFiles

withProtoFiles

withGenerator

withOutput

withOptions

equals

hashCode

toString

copyOf

builder