alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (MultilineRecursiveToStringStyle.java)

This example Java source code file (MultilineRecursiveToStringStyle.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

multilinerecursivetostringstyle, object, override, string, stringbuffer, stringbuilder

The MultilineRecursiveToStringStyle.java Java example source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.lang3.builder;

import org.apache.commons.lang3.ClassUtils;
import org.apache.commons.lang3.SystemUtils;

/**
 * <p>Works with {@link ToStringBuilder} to create a "deep" toString.
 * But instead a single line like the {@link RecursiveToStringStyle} this creates a multiline String 
 * similar to the {@link ToStringStyle#MULTI_LINE_STYLE}.</p>
 * 
 * <p>To use this class write code as follows:

* * <pre> * public class Job { * String title; * ... * } * * public class Person { * String name; * int age; * boolean smoker; * Job job; * * ... * * public String toString() { * return new ReflectionToStringBuilder(this, new MultilineRecursiveToStringStyle()).toString(); * } * } * </pre> * * <p> * This will produce a toString of the format:<br> * <code>Person@7f54[
*   name=Stephen, <br> *   age=29, <br> *   smoker=false, <br> *   job=Job@43cd2[ <br> *     title=Manager <br> *   ] <br> * ] * </code> * </p> * * @since 3.4 */ public class MultilineRecursiveToStringStyle extends RecursiveToStringStyle { /** * Required for serialization support. * @see java.io.Serializable */ private static final long serialVersionUID = 1L; /** Indenting of inner lines. */ private int indent = 2; /** Current indenting. */ private int spaces = 2; /** * Constructor. */ public MultilineRecursiveToStringStyle() { super(); resetIndent(); } /** * Resets the fields responsible for the line breaks and indenting. * Must be invoked after changing the {@link #spaces} value. */ private void resetIndent() { setArrayStart("{" + SystemUtils.LINE_SEPARATOR + spacer(spaces)); setArraySeparator("," + SystemUtils.LINE_SEPARATOR + spacer(spaces)); setArrayEnd(SystemUtils.LINE_SEPARATOR + spacer(spaces - indent) + "}"); setContentStart("[" + SystemUtils.LINE_SEPARATOR + spacer(spaces)); setFieldSeparator("," + SystemUtils.LINE_SEPARATOR + spacer(spaces)); setContentEnd(SystemUtils.LINE_SEPARATOR + spacer(spaces - indent) + "]"); } /** * Creates a StringBuilder responsible for the indenting. * * @param spaces how far to indent * @return a StringBuilder with {spaces} leading space characters. */ private StringBuilder spacer(int spaces) { StringBuilder sb = new StringBuilder(); for (int i = 0; i < spaces; i++) { sb.append(" "); } return sb; } @Override public void appendDetail(StringBuffer buffer, String fieldName, Object value) { if (!ClassUtils.isPrimitiveWrapper(value.getClass()) && !String.class.equals(value.getClass()) && accept(value.getClass())) { spaces += indent; resetIndent(); buffer.append(ReflectionToStringBuilder.toString(value, this)); spaces -= indent; resetIndent(); } else { super.appendDetail(buffer, fieldName, value); } } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final Object[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void reflectionAppendArrayDetail(final StringBuffer buffer, final String fieldName, final Object array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final long[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final int[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final short[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final byte[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final char[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final double[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final float[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } @Override protected void appendDetail(final StringBuffer buffer, final String fieldName, final boolean[] array) { spaces += indent; resetIndent(); super.appendDetail(buffer, fieldName, array); spaces -= indent; resetIndent(); } }

Other Java examples (source code examples)

Here is a short list of links related to this Java MultilineRecursiveToStringStyle.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.