org.mutabilitydetector.checkers.hint

Class WrappingHint

java.lang.Object

org.mutabilitydetector.checkers.hint.WrappingHint

public final class WrappingHint
extends Object

When collection field of class is initialized, it is common to use copy-and-wrap idiom to make the collection immutable.

For example:

this.list = Collections.unmodifiableList(new ArrayList(list))

When mentioned idiom is not used correctly, or not used at all class WrappingHint will represent a hint to help user apply copy-and-wrap idiom in a correct way.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappingHint.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static WrappingHint	NO_HINT

Method Summary

Modifier and Type	Method and Description
static WrappingHint.Builder	builder()
String	getWrappingHint(String fieldName) For given field name get the actual hint message
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Field Detail

NO_HINT

public static final WrappingHint NO_HINT

Method Detail

getWrappingHint

public String getWrappingHint(String fieldName)

For given field name get the actual hint message

isEmpty

public boolean isEmpty()

builder

public static WrappingHint.Builder builder()