/*
* Copyright (C) 2014 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.glassfish.jersey.internal.guava;
import static org.glassfish.jersey.internal.guava.Preconditions.checkNotNull;
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
.
Author: Laurence Gonsalves Since: 18.0 (since 2.0 as Objects
)
/**
* Helper functions that operate on any {@code Object}, and are not already provided in
* {@link java.util.Objects}.
* <p>
* <p>See the Guava User Guide on <a
* href="http://code.google.com/p/guava-libraries/wiki/CommonObjectUtilitiesExplained">writing
* {@code Object} methods with {@code MoreObjects}</a>.
*
* @author Laurence Gonsalves
* @since 18.0 (since 2.0 as {@code Objects})
*/
public final class MoreObjects {
private MoreObjects() {
}
Creates an instance of ToStringHelper
.
This is helpful for implementing Object.toString()
. Specification by example:
// Returns "ClassName{}"
MoreObjects.toStringHelper(this)
.toString();
<p>
// Returns "ClassName{x=1}"
MoreObjects.toStringHelper(this)
.add("x", 1)
.toString();
<p>
// Returns "MyObject{x=1}"
MoreObjects.toStringHelper("MyObject")
.add("x", 1)
.toString();
<p>
// Returns "ClassName{x=1, y=foo}"
MoreObjects.toStringHelper(this)
.add("x", 1)
.add("y", "foo")
.toString();
<p>
// Returns "ClassName{x=1}"
MoreObjects.toStringHelper(this)
.omitNullValues()
.add("x", 1)
.add("y", null)
.toString();
}
Note that in GWT, class names are often obfuscated.
Params: - 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()
.
/**
* Creates an instance of {@link ToStringHelper}.
* <p>
* <p>This is helpful for implementing {@link Object#toString()}.
* Specification by example: <pre> {@code
* // Returns "ClassName{}"
* MoreObjects.toStringHelper(this)
* .toString();
* <p>
* // Returns "ClassName{x=1}"
* MoreObjects.toStringHelper(this)
* .add("x", 1)
* .toString();
* <p>
* // Returns "MyObject{x=1}"
* MoreObjects.toStringHelper("MyObject")
* .add("x", 1)
* .toString();
* <p>
* // Returns "ClassName{x=1, y=foo}"
* MoreObjects.toStringHelper(this)
* .add("x", 1)
* .add("y", "foo")
* .toString();
* <p>
* // Returns "ClassName{x=1}"
* MoreObjects.toStringHelper(this)
* .omitNullValues()
* .add("x", 1)
* .add("y", null)
* .toString();
* }}</pre>
* <p>
* <p>Note that in GWT, class names are often obfuscated.
*
* @param self the object to generate the string for (typically {@code this}), used only for its
* class name
* @since 18.0 (since 2.0 as {@code Objects.toStringHelper()}.
*/
public static ToStringHelper toStringHelper(Object self) {
return new ToStringHelper(simpleName(self.getClass()));
}
Class.getSimpleName()
is not GWT compatible yet, so we provide our own implementation. /**
* {@link Class#getSimpleName()} is not GWT compatible yet, so we
* provide our own implementation.
*/
// Package-private so Objects can call it.
private static String simpleName(Class<?> clazz) {
String name = clazz.getName();
// the nth anonymous class has a class name ending in "Outer$n"
// and local inner classes have names ending in "Outer.$1Inner"
name = name.replaceAll("\\$[0-9]+", "\\$");
// we want the name of the inner class all by its lonesome
int start = name.lastIndexOf('$');
// if this isn't an inner class, just find the start of the
// top level class name.
if (start == -1) {
start = name.lastIndexOf('.');
}
return name.substring(start + 1);
}
Support class for MoreObjects.toStringHelper
. Author: Jason Lee Since: 18.0 (since 2.0 as Objects.ToStringHelper
.
/**
* Support class for {@link MoreObjects#toStringHelper}.
*
* @author Jason Lee
* @since 18.0 (since 2.0 as {@code Objects.ToStringHelper}.
*/
public static final class ToStringHelper {
private final String className;
private final ValueHolder holderHead = new ValueHolder();
private ValueHolder holderTail = holderHead;
private final boolean omitNullValues = false;
Use MoreObjects.toStringHelper(Object)
to create an instance. /**
* Use {@link MoreObjects#toStringHelper(Object)} to create an instance.
*/
private ToStringHelper(String className) {
this.className = Preconditions.checkNotNull(className);
}
Adds a name/value pair to the formatted output in name=value
format. If value
is null
, the string "null"
is used, unless omitNullValues()
is called, in which case this name/value pair will not be added. /**
* Adds a name/value pair to the formatted output in {@code name=value}
* format. If {@code value} is {@code null}, the string {@code "null"}
* is used, unless {@link #omitNullValues()} is called, in which case this
* name/value pair will not be added.
*/
public ToStringHelper add(String name, Object value) {
return addHolder(name, value);
}
Adds a name/value pair to the formatted output in name=value
format. Since: 18.0 (since 11.0 as Objects.ToStringHelper.omitNullValues()
.
/**
* Adds a name/value pair to the formatted output in {@code name=value}
* format.
*
* @since 18.0 (since 11.0 as {@code Objects.ToStringHelper.omitNullValues()}.
*/
public ToStringHelper add(String name, int value) {
return addHolder(name, String.valueOf(value));
}
Adds a name/value pair to the formatted output in name=value
format. Since: 18.0 (since 11.0 as Objects.ToStringHelper.omitNullValues()
.
/**
* Adds a name/value pair to the formatted output in {@code name=value}
* format.
*
* @since 18.0 (since 11.0 as {@code Objects.ToStringHelper.omitNullValues()}.
*/
public ToStringHelper add(String name, long value) {
return addHolder(name, String.valueOf(value));
}
Returns a string in the format specified by MoreObjects.toStringHelper(Object)
.
After calling this method, you can keep adding more properties to later
call toString() again and get a more complete representation of the
same object; but properties cannot be removed, so this only allows
limited reuse of the helper instance. The helper allows duplication of
properties (multiple name/value pairs with the same name can be added).
/**
* Returns a string in the format specified by
* {@link MoreObjects#toStringHelper(Object)}.
* <p>
* <p>After calling this method, you can keep adding more properties to later
* call toString() again and get a more complete representation of the
* same object; but properties cannot be removed, so this only allows
* limited reuse of the helper instance. The helper allows duplication of
* properties (multiple name/value pairs with the same name can be added).
*/
@Override
public String toString() {
// create a copy to keep it consistent in case value changes
String nextSeparator = "";
StringBuilder builder = new StringBuilder(32).append(className)
.append('{');
for (ValueHolder valueHolder = holderHead.next; valueHolder != null;
valueHolder = valueHolder.next) {
if (!omitNullValues || valueHolder.value != null) {
builder.append(nextSeparator);
nextSeparator = ", ";
if (valueHolder.name != null) {
builder.append(valueHolder.name).append('=');
}
builder.append(valueHolder.value);
}
}
return builder.append('}').toString();
}
private ValueHolder addHolder() {
ValueHolder valueHolder = new ValueHolder();
holderTail = holderTail.next = valueHolder;
return valueHolder;
}
private ToStringHelper addHolder(String name, Object value) {
ValueHolder valueHolder = addHolder();
valueHolder.value = value;
valueHolder.name = Preconditions.checkNotNull(name);
return this;
}
private static final class ValueHolder {
String name;
Object value;
ValueHolder next;
}
}
}