com.netflix.spectator.api.patterns

Class IdBuilder<T>

java.lang.Object

com.netflix.spectator.api.patterns.IdBuilder<T>

public abstract class IdBuilder<T>
extends Object

Base type for builders that are required to construct an Id object. This class assists with the creation of a base id and then returns another builder type that can be used for further refinement. By following this pattern the builder will force the user to satisfy the minimal constraints of the id before a final option to construct or complete the operation is provided.

Sample usage:

   return new IdBuilder(registry) {
      @Override protected Builder createTypeBuilder(Id id) {
       return new Builder(registry, id);
     }
   };
 

The type returned by createTypeBuilder(Id) can extend TagsBuilder to easily support additional tags being added after the base id requirements are satisfied.

Field Summary

Fields

Modifier and Type	Field and Description
protected Registry	registry Registry used for created ids.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdBuilder(Registry registry) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract T	createTypeBuilder(Id id) Sub-classes should override this method to create the more specific builder type.
T	withId(Id id) Set the base identifier for the type being constructed.
T	withName(String name) Create a new identifier with the provide name.

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected final Registry registry

Registry used for created ids.

Constructor Detail

IdBuilder

protected IdBuilder(Registry registry)

Create a new instance.

Method Detail

createTypeBuilder

protected abstract T createTypeBuilder(Id id)

Sub-classes should override this method to create the more specific builder type.

withName

public T withName(String name)

Create a new identifier with the provide name.

Parameters:

name - Name used in the identifier.

Returns:

Builder object to allow for method chaining.

withId

public T withId(Id id)

Set the base identifier for the type being constructed.

Parameters:

id - Identifier for the type being constructed.

Returns:

Builder object to allow for method chaining.