Class ThreadSafety.Builder

java.lang.Object

com.google.errorprone.bugpatterns.threadsafety.ThreadSafety.Builder

Enclosing class:

ThreadSafety

public static class ThreadSafety.Builder
extends Object

ThreadSafetyBuilder

Method Summary

Modifier and Type	Method	Description
ThreadSafety.Builder	acceptedAnnotations(Iterable<String> acceptedAnnotations)	Annotations that do *not* cause a class to be tested, but which are treated as valid annotations to pass the test; for example, if @ThreadSafe is the marker annotation, @Immutable would be included in this list, as an immutable class is by definition thread-safe.
ThreadSafety	build(VisitorState state)
ThreadSafety.Builder	containerOfAnnotation(Class<? extends Annotation> containerOfAnnotation)	An annotation which marks a generic parameter as a container type.
ThreadSafety.Builder	containerOfAnnotation(Iterable<String> containerOfAnnotation)	An annotation which marks a generic parameter as a container type.
ThreadSafety.Builder	knownTypes(ThreadSafetyKnownTypes knownTypes)	Information about known types and whether they're known to be safe or unsafe.
ThreadSafety.Builder	markerAnnotations(Iterable<String> markerAnnotations)	Annotations that will cause a class to be tested with this ThreadSafety instance; for example, when testing a class for immutability, this should be @Immutable.
ThreadSafety.Builder	setPurpose(ThreadSafety.Purpose purpose)	See ThreadSafety.Purpose.
ThreadSafety.Builder	suppressAnnotation(Class<? extends Annotation> suppressAnnotation)	An annotation which, when found on a class, should suppress the test
ThreadSafety.Builder	suppressAnnotation(Iterable<String> suppressAnnotation)	An annotation which, when found on a class, should suppress the test
ThreadSafety.Builder	typeParameterAnnotation(Class<? extends Annotation> typeParameterAnnotation)	An annotation which, when found on a type parameter, indicates that the type parameter may only be instantiated with thread-safe types.
ThreadSafety.Builder	typeParameterAnnotation(Iterable<String> typeParameterAnnotation)	An annotation which, when found on a type parameter, indicates that the type parameter may only be instantiated with thread-safe types.

Methods inherited from class java.lang.Object

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

Method Details

setPurpose

@CanIgnoreReturnValue
public ThreadSafety.Builder setPurpose(ThreadSafety.Purpose purpose)

See ThreadSafety.Purpose.

knownTypes

@CanIgnoreReturnValue
public ThreadSafety.Builder knownTypes(ThreadSafetyKnownTypes knownTypes)

Information about known types and whether they're known to be safe or unsafe.

markerAnnotations

@CanIgnoreReturnValue
public ThreadSafety.Builder markerAnnotations(Iterable<String> markerAnnotations)

Annotations that will cause a class to be tested with this ThreadSafety instance; for example, when testing a class for immutability, this should be @Immutable.

acceptedAnnotations

@CanIgnoreReturnValue
public ThreadSafety.Builder acceptedAnnotations(Iterable<String> acceptedAnnotations)

Annotations that do *not* cause a class to be tested, but which are treated as valid annotations to pass the test; for example, if @ThreadSafe is the marker annotation, @Immutable would be included in this list, as an immutable class is by definition thread-safe.

containerOfAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder containerOfAnnotation(Class<? extends Annotation> containerOfAnnotation)

An annotation which marks a generic parameter as a container type.

containerOfAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder containerOfAnnotation(Iterable<String> containerOfAnnotation)

An annotation which marks a generic parameter as a container type.

suppressAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder suppressAnnotation(Class<? extends Annotation> suppressAnnotation)

An annotation which, when found on a class, should suppress the test

suppressAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder suppressAnnotation(Iterable<String> suppressAnnotation)

An annotation which, when found on a class, should suppress the test

typeParameterAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder typeParameterAnnotation(Class<? extends Annotation> typeParameterAnnotation)

An annotation which, when found on a type parameter, indicates that the type parameter may only be instantiated with thread-safe types.

typeParameterAnnotation

@CanIgnoreReturnValue
public ThreadSafety.Builder typeParameterAnnotation(Iterable<String> typeParameterAnnotation)

An annotation which, when found on a type parameter, indicates that the type parameter may only be instantiated with thread-safe types.

build

public ThreadSafety build(VisitorState state)