Java Doc for ReflectionToStringBuilder.java in  » Library » Apache-common-lang » org » apache » commons » lang » builder » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Assists in implementing Object.toString methods using reflection.

This class uses reflection to determine the fields to append. Because these fields are usually private, the class uses java.lang.reflect.AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[]boolean) to change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions are set up correctly.

A typical invocation for this method would look like:

 public String toString() {
 return ReflectionToStringBuilder.toString(this);
 }

You can also use the builder to debug 3rd party objects:

 System.out.println("An object: " + ReflectionToStringBuilder.toString(anObject));

A subclass can control field output by overriding the methods:

• ReflectionToStringBuilder.accept(java.lang.reflect.Field)
• ReflectionToStringBuilder.getValue(java.lang.reflect.Field)

For example, this method does not include the password field in the returned String:

 public String toString() {
 return (new ReflectionToStringBuilder(this) {
 protected boolean accept(Field f) {
 return super.accept(f) && !f.getName().equals("password");
 }
 }).toString();
 }

The exact format of the toString is determined by the ToStringStyle passed into the constructor.

Constructor.

Constructor.

Constructor.

• Transient fields are appended only if ReflectionToStringBuilder.isAppendTransients() returns true.
• Static fields are appended only if ReflectionToStringBuilder.isAppendStatics() returns true.
• Inner class fields are not appened.

Appends the fields and values defined by the given object of the given Class.

Gets the last super class to stop appending fields for.

Calls java.lang.reflect.Field.get(Object).

Gets whether or not to append static fields.

Gets whether or not to append transient fields.

Append to the toString an Object array.

Sets whether or not to append static fields.

Sets whether or not to append transient fields.

Sets the last super class to stop appending fields for.

Builds a toString value using the default ToStringStyle through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields.

Gets the String built by this builder.

Constructor.

This constructor outputs using the default style set with setDefaultStyle.

Constructor.

If the style is null, the default style is used.

Constructor.

If the style is null, the default style is used.

If the buffer is null, a new one is created.

• Transient fields are appended only if ReflectionToStringBuilder.isAppendTransients() returns true.
• Static fields are appended only if ReflectionToStringBuilder.isAppendStatics() returns true.
• Inner class fields are not appened.

Appends the fields and values defined by the given object of the given Class.

If a cycle is detected as an object is "toString()'ed", such an object is rendered as if Object.toString() had been called and not implemented by the object.

Gets the last super class to stop appending fields for.

Calls java.lang.reflect.Field.get(Object).

Gets whether or not to append static fields.

Gets whether or not to append transient fields.

Append to the toString an Object array.

Sets whether or not to append static fields.

Sets whether or not to append transient fields.

Sets the last super class to stop appending fields for.

Builds a toString value using the default ToStringStyle through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

Transient members will be not be included, as they are likely derived. Static fields will not be included. Superclass fields will be appended.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

Transient members will be not be included, as they are likely derived. Static fields will not be included. Superclass fields will be appended.

If the style is null, the default ToStringStyle is used.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

If the outputTransients is true, transient members will be output, otherwise they are ignored, as they are likely derived fields, and not part of the value of the Object.

Static fields will not be included. Superclass fields will be appended.

If the style is null, the default ToStringStyle is used.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

If the outputTransients is true, transient fields will be output, otherwise they are ignored, as they are likely derived fields, and not part of the value of the Object.

If the outputStatics is true, static fields will be output, otherwise they are ignored.

Static fields will not be included. Superclass fields will be appended.

If the style is null, the default ToStringStyle is used.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

If the outputTransients is true, transient fields will be output, otherwise they are ignored, as they are likely derived fields, and not part of the value of the Object.

If the outputStatics is true, static fields will be output, otherwise they are ignored.

Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as java.lang.Object.

If the style is null, the default ToStringStyle is used.

Builds a toString value through reflection.

It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.

If the outputTransients is true, transient members will be output, otherwise they are ignored, as they are likely derived fields, and not part of the value of the Object.

Static fields will not be included. Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as java.lang.Object.

If the style is null, the default ToStringStyle is used.

Gets the String built by this builder.