com.diffplug.common.base

Class MoreObjects

java.lang.Object

com.diffplug.common.base.MoreObjects

@GwtCompatible
public final class MoreObjects
extends Object

Helper functions that operate on any Object, and are not already provided in Objects.

See the Guava User Guide on writing Object methods with MoreObjects.

Since:

18.0 (since 2.0 as Objects)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoreObjects.ToStringHelper Support class for toStringHelper(java.lang.Object).

Method Summary

Modifier and Type	Method and Description
static <T> T	firstNonNull(T first, T second) Returns the first of two given parameters that is not null, if either is, or otherwise throws a NullPointerException.
static MoreObjects.ToStringHelper	toStringHelper(Class<?> clazz) Creates an instance of MoreObjects.ToStringHelper in the same manner as toStringHelper(Object), but using the simple name of clazz instead of using an instance’s Object.getClass().
static MoreObjects.ToStringHelper	toStringHelper(Object self) Creates an instance of MoreObjects.ToStringHelper.
static MoreObjects.ToStringHelper	toStringHelper(String className) Creates an instance of MoreObjects.ToStringHelper in the same manner as toStringHelper(Object), but using className instead of using an instance’s Object.getClass().

Methods inherited from class java.lang.Object

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

Method Detail

firstNonNull

@CheckReturnValue
public static <T> T firstNonNull(@Nullable
                                                   T first,
                                                   @Nullable
                                                   T second)

Returns the first of two given parameters that is not null, if either is, or otherwise throws a NullPointerException.

Note: if first is represented as an Optional, this can be accomplished with first.or(second). That approach also allows for lazy evaluation of the fallback instance, using first.or(supplier).

Returns:

first if it is non-null; otherwise second if it is non-null

Throws:

NullPointerException - if both first and second are null

Since:

18.0 (since 3.0 as Objects.firstNonNull()).

toStringHelper

@CheckReturnValue
public static MoreObjects.ToStringHelper toStringHelper(Object self)

Creates an instance of MoreObjects.ToStringHelper.

This is helpful for implementing Object.toString(). Specification by example:

 
  // Returns "ClassName{}&quot;  MoreObjects.toStringHelper(this)  .toString();</p>
<p>// Returns &ldquo;ClassName{x=1}&rdquo;  MoreObjects.toStringHelper(this)  .add(&ldquo;x&rdquo;, 1)  .toString();</p>
<p>// Returns &ldquo;MyObject{x=1}&rdquo;  MoreObjects.toStringHelper(&ldquo;MyObject&rdquo;)  .add(&ldquo;x&rdquo;, 1)  .toString();</p>
<p>// Returns &ldquo;ClassName{x=1, y=foo}&rdquo;  MoreObjects.toStringHelper(this)  .add(&ldquo;x&rdquo;, 1)  .add(&ldquo;y&rdquo;, &ldquo;foo&rdquo;)  .toString();</p>
<p>// Returns &ldquo;ClassName{x=1}&rdquo;  MoreObjects.toStringHelper(this)  .omitNullValues()  .add(&ldquo;x&rdquo;, 1)  .add(&ldquo;y&rdquo;, null)  .toString();  }

Note that in GWT, class names are often obfuscated.

Parameters:

self - the object to generate the string for (typically this), used only for its class name

Since:

18.0 (since 2.0 as Objects.toStringHelper()).

toStringHelper

@CheckReturnValue
public static MoreObjects.ToStringHelper toStringHelper(Class<?> clazz)

Creates an instance of MoreObjects.ToStringHelper in the same manner as toStringHelper(Object), but using the simple name of clazz instead of using an instance’s Object.getClass().

Note that in GWT, class names are often obfuscated.

Parameters:

clazz - the Class of the instance

Since:

18.0 (since 7.0 as Objects.toStringHelper()).

toStringHelper

@CheckReturnValue
public static MoreObjects.ToStringHelper toStringHelper(String className)

Creates an instance of MoreObjects.ToStringHelper in the same manner as toStringHelper(Object), but using className instead of using an instance’s Object.getClass().

Parameters:

className - the name of the instance type

Since:

18.0 (since 7.0 as Objects.toStringHelper()).