org.starchartlabs.alloy.core

Class MoreObjects

java.lang.Object

org.starchartlabs.alloy.core.MoreObjects

public class MoreObjects
extends java.lang.Object

Provides methods for streamlining and reducing boilerplate in relation to basic Object operations

Since:

0.1.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MoreObjects()

Method Summary

Modifier and Type	Method and Description
static MoreObjects.ToStringHelper	toStringHelper(java.lang.Class<?> clazz) Creates an instance of MoreObjects.ToStringHelper.
static MoreObjects.ToStringHelper	toStringHelper(java.lang.Object self) Creates an instance of MoreObjects.ToStringHelper.
static MoreObjects.ToStringHelper	toStringHelper(java.lang.String className) Creates an instance of MoreObjects.ToStringHelper.

Methods inherited from class java.lang.Object

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

Constructor Detail

MoreObjects

public MoreObjects()

Method Detail

toStringHelper

public static MoreObjects.ToStringHelper toStringHelper(java.lang.Object self)

Creates an instance of MoreObjects.ToStringHelper.

This is helpful for implementing Object.toString(). Example:

 
   // Returns "ClassName{}"
   MoreObjects.toStringHelper(this)
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .toString();

   // Returns "MyObject{x=1}"
   MoreObjects.toStringHelper("MyObject")
       .add("x", 1)
       .toString();

   // Returns "ClassName{x=1, y=foo}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .add("y", "foo")
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .omitNullValues()
       .add("x", 1)
       .add("y", null)
       .toString();
   }
 

Parameters:

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

Returns:

A builder designed for streamlined implementation of Object.toString()

Since:

0.1.0

toStringHelper

public static MoreObjects.ToStringHelper toStringHelper(java.lang.Class<?> clazz)

Creates an instance of MoreObjects.ToStringHelper.

This is helpful for implementing Object.toString(). Example:

 
   // Returns "ClassName{}"
   MoreObjects.toStringHelper(this)
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .toString();

   // Returns "MyObject{x=1}"
   MoreObjects.toStringHelper("MyObject")
       .add("x", 1)
       .toString();

   // Returns "ClassName{x=1, y=foo}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .add("y", "foo")
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .omitNullValues()
       .add("x", 1)
       .add("y", null)
       .toString();
   }
 

Parameters:

clazz - The Class of the instance, used only for its class name

Returns:

A builder designed for streamlined implementation of Object.toString()

Since:

0.1.0

toStringHelper

public static MoreObjects.ToStringHelper toStringHelper(java.lang.String className)

Creates an instance of MoreObjects.ToStringHelper.

This is helpful for implementing Object.toString(). Example:

 
   // Returns "ClassName{}"
   MoreObjects.toStringHelper(this)
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .toString();

   // Returns "MyObject{x=1}"
   MoreObjects.toStringHelper("MyObject")
       .add("x", 1)
       .toString();

   // Returns "ClassName{x=1, y=foo}"
   MoreObjects.toStringHelper(this)
       .add("x", 1)
       .add("y", "foo")
       .toString();

   // Returns "ClassName{x=1}"
   MoreObjects.toStringHelper(this)
       .omitNullValues()
       .add("x", 1)
       .add("y", null)
       .toString();
   }
 

Parameters:

className - The name of the instance type

Returns:

A builder designed for streamlined implementation of Object.toString()

Since:

0.1.0