com.github.robtimus.obfuscation.commons.lang3

Class ObfuscatingToStringStyle

java.lang.Object

org.apache.commons.lang3.builder.ToStringStyle

com.github.robtimus.obfuscation.commons.lang3.ObfuscatingToStringStyle

All Implemented Interfaces:

Serializable

public abstract class ObfuscatingToStringStyle
extends org.apache.commons.lang3.builder.ToStringStyle

A ToStringStyle that can obfuscate fields.

An ObfuscatingToStringStyle object is not thread safe nor stateless, and should not be reused for multiple objects concurrently. However, a ObfuscatingToStringStyle.Builder can build immutable Suppliers of ObfuscatingToStringStyle which can be safely reused for multiple objects and in multiple threads. Such a Supplier can be used directly, or perhaps in combination with ThreadLocal.withInitial(Supplier). For instance, in a class:

 private static final Supplier<ObfuscatingToStringStyle> TO_STRING_STYLE = ObfuscatingToStringStyle.defaultStyle()
         ...
         .supplier();

 ...

 public String toString() {
     return ToStringBuilder.reflectionToString(this, TO_STRING_STYLE.get());
 }
 

Note: instances of ObfuscatingToStringStyle are not serializable.

Author:

Rob Spoor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObfuscatingToStringStyle.Builder A builder for creating obfuscating ToStringStyle objects.
static class	ObfuscatingToStringStyle.FieldConfigurer An object that can be used to configure a field that should be obfuscated.

Field Summary

Fields inherited from class org.apache.commons.lang3.builder.ToStringStyle

DEFAULT_STYLE, JSON_STYLE, MULTI_LINE_STYLE, NO_CLASS_NAME_STYLE, NO_FIELD_NAMES_STYLE, SHORT_PREFIX_STYLE, SIMPLE_STYLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObfuscatingToStringStyle(ObfuscatingToStringStyle.Builder.Snapshot snapshot) Creates a new obfuscating ToStringStyle.
protected	ObfuscatingToStringStyle(ObfuscatingToStringStyle.Builder builder) Creates a new obfuscating ToStringStyle.

Method Summary

Modifier and Type	Method and Description
protected void	appendDetail(StringBuffer buffer, String fieldName, boolean value)
protected void	appendDetail(StringBuffer buffer, String fieldName, boolean[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, byte value)
protected void	appendDetail(StringBuffer buffer, String fieldName, byte[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, char value)
protected void	appendDetail(StringBuffer buffer, String fieldName, char[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, Collection<?> coll)
protected void	appendDetail(StringBuffer buffer, String fieldName, double value)
protected void	appendDetail(StringBuffer buffer, String fieldName, double[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, float value)
protected void	appendDetail(StringBuffer buffer, String fieldName, float[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, int value)
protected void	appendDetail(StringBuffer buffer, String fieldName, int[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, long value)
protected void	appendDetail(StringBuffer buffer, String fieldName, long[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, Map<?,?> map)
protected void	appendDetail(StringBuffer buffer, String fieldName, Object value)
protected void	appendDetail(StringBuffer buffer, String fieldName, Object[] array)
protected void	appendDetail(StringBuffer buffer, String fieldName, short value)
protected void	appendDetail(StringBuffer buffer, String fieldName, short[] array)
protected void	appendNullText(StringBuffer buffer, String fieldName)
protected void	appendSummary(StringBuffer buffer, String fieldName, Object value)
protected void	appendSummarySize(StringBuffer buffer, String fieldName, int size)
static ObfuscatingToStringStyle.Builder	defaultStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.DEFAULT_STYLE.
static ObfuscatingToStringStyle.Builder	multiLineRecursiveStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to MultilineRecursiveToStringStyle.
static ObfuscatingToStringStyle.Builder	multiLineRecursiveStyle(Predicate<? super Class<?>> recurseIntoPredicate) Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to MultilineRecursiveToStringStyle.
static ObfuscatingToStringStyle.Builder	multiLineStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.MULTI_LINE_STYLE.
static ObfuscatingToStringStyle.Builder	noClassNameStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_CLASS_NAME_STYLE.
static ObfuscatingToStringStyle.Builder	noFieldNamesStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_FIELD_NAMES_STYLE.
static ObfuscatingToStringStyle.Builder	recursiveStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.
static ObfuscatingToStringStyle.Builder	recursiveStyle(Predicate<? super Class<?>> recurseIntoPredicate) Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.
protected void	reflectionAppendArrayDetail(StringBuffer buffer, String fieldName, Object array)
static ObfuscatingToStringStyle.Builder	shortPrefixStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SHORT_PREFIX_STYLE.
static ObfuscatingToStringStyle.Builder	simpleStyle() Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SIMPLE_STYLE.

Methods inherited from class org.apache.commons.lang3.builder.ToStringStyle

append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendClassName, appendContentEnd, appendContentStart, appendCyclicObject, appendDetail, appendEnd, appendFieldEnd, appendFieldSeparator, appendFieldStart, appendIdentityHashCode, appendInternal, appendStart, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSummary, appendSuper, appendToString, getArrayEnd, getArraySeparator, getArrayStart, getContentEnd, getContentStart, getFieldNameValueSeparator, getFieldSeparator, getNullText, getRegistry, getShortClassName, getSizeEndText, getSizeStartText, getSummaryObjectEndText, getSummaryObjectStartText, isArrayContentDetail, isDefaultFullDetail, isFieldSeparatorAtEnd, isFieldSeparatorAtStart, isFullDetail, isUseClassName, isUseFieldNames, isUseIdentityHashCode, isUseShortClassName, removeLastFieldSeparator, setArrayContentDetail, setArrayEnd, setArraySeparator, setArrayStart, setContentEnd, setContentStart, setDefaultFullDetail, setFieldNameValueSeparator, setFieldSeparator, setFieldSeparatorAtEnd, setFieldSeparatorAtStart, setNullText, setSizeEndText, setSizeStartText, setSummaryObjectEndText, setSummaryObjectStartText, setUseClassName, setUseFieldNames, setUseIdentityHashCode, setUseShortClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

ObfuscatingToStringStyle

protected ObfuscatingToStringStyle(ObfuscatingToStringStyle.Builder builder)

Creates a new obfuscating ToStringStyle.

Parameters:

builder - The builder with the settings to use for creating the obfuscating ToStringStyle.

Throws:

NullPointerException - If the given builder is null.

ObfuscatingToStringStyle

protected ObfuscatingToStringStyle(ObfuscatingToStringStyle.Builder.Snapshot snapshot)

Creates a new obfuscating ToStringStyle.

Parameters:

snapshot - A builder snapshot with the settings to use for creating the obfuscating ToStringStyle.

Throws:

NullPointerException - If the given snapshot is null.

Method Detail

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            Object value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendSummary

protected void appendSummary(StringBuffer buffer,
                             String fieldName,
                             Object value)

Overrides:

appendSummary in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            Collection<?> coll)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            Map<?,?> map)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            long value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            int value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            short value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            byte value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            char value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            double value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            float value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            boolean value)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            Object[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

reflectionAppendArrayDetail

protected void reflectionAppendArrayDetail(StringBuffer buffer,
                                           String fieldName,
                                           Object array)

Overrides:

reflectionAppendArrayDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            long[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            int[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            short[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            byte[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            char[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            double[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            float[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendDetail

protected void appendDetail(StringBuffer buffer,
                            String fieldName,
                            boolean[] array)

Overrides:

appendDetail in class org.apache.commons.lang3.builder.ToStringStyle

appendNullText

protected void appendNullText(StringBuffer buffer,
                              String fieldName)

Overrides:

appendNullText in class org.apache.commons.lang3.builder.ToStringStyle

appendSummarySize

protected void appendSummarySize(StringBuffer buffer,
                                 String fieldName,
                                 int size)

Overrides:

appendSummarySize in class org.apache.commons.lang3.builder.ToStringStyle

defaultStyle

public static ObfuscatingToStringStyle.Builder defaultStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.DEFAULT_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.DEFAULT_STYLE.

multiLineStyle

public static ObfuscatingToStringStyle.Builder multiLineStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.MULTI_LINE_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.MULTI_LINE_STYLE.

noFieldNamesStyle

public static ObfuscatingToStringStyle.Builder noFieldNamesStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_FIELD_NAMES_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_FIELD_NAMES_STYLE.

shortPrefixStyle

public static ObfuscatingToStringStyle.Builder shortPrefixStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SHORT_PREFIX_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SHORT_PREFIX_STYLE.

simpleStyle

public static ObfuscatingToStringStyle.Builder simpleStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SIMPLE_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.SIMPLE_STYLE.

noClassNameStyle

public static ObfuscatingToStringStyle.Builder noClassNameStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_CLASS_NAME_STYLE.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to ToStringStyle.NO_CLASS_NAME_STYLE.

recursiveStyle

public static ObfuscatingToStringStyle.Builder recursiveStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle. This method is similar to calling recursiveStyle(Predicate) with a predicate that always returns true.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.

recursiveStyle

public static ObfuscatingToStringStyle.Builder recursiveStyle(Predicate<? super Class<?>> recurseIntoPredicate)

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.

Parameters:

recurseIntoPredicate - A predicate that determines which classes are recursively formatted. Note that primitive types, primitive wrappers and String are never recursively formatted.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.

multiLineRecursiveStyle

public static ObfuscatingToStringStyle.Builder multiLineRecursiveStyle()

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to MultilineRecursiveToStringStyle. This method is similar to calling recursiveStyle(Predicate) with a predicate that always returns true.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.

multiLineRecursiveStyle

public static ObfuscatingToStringStyle.Builder multiLineRecursiveStyle(Predicate<? super Class<?>> recurseIntoPredicate)

Returns a builder that creates obfuscating ToStringStyle objects that produce output similar to MultilineRecursiveToStringStyle.

Parameters:

recurseIntoPredicate - A predicate that determines which classes are recursively formatted. Note that primitive types, primitive wrappers and String are never recursively formatted.

Returns:

A builder that creates obfuscating ToStringStyle objects that produce output similar to RecursiveToStringStyle.