org.glassfish.admin.amx.util.stringifier.IteratorStringifierBase Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
//Portions Copyright [2018-2019] [Payara Foundation and/or affiliates]
package org.glassfish.admin.amx.util.stringifier;

import java.util.Iterator;

/**
 * Stringifies an {@link Iterator}, using an optional element Stringifier.
 *
 * Must be subclassed to provide Stringification of an element.
 */
public abstract class IteratorStringifierBase implements Stringifier {

    public static final IteratorStringifier DEFAULT = new IteratorStringifier(",");
    
    public final String mDelim;
    public final Stringifier mElementStringifier;

    public IteratorStringifierBase() {
        this(ObjectStringifier.DEFAULT);
    }

    public IteratorStringifierBase(String delim) {
        this(delim, new SmartStringifier(delim));
    }

    public IteratorStringifierBase(Stringifier elementStringifier) {
        this(",", elementStringifier);
    }

    public IteratorStringifierBase(String delim, Stringifier elementStringifier) {
        mDelim = delim;
        mElementStringifier = elementStringifier;
    }

    @Override
    public String stringify(Object o) {
        assert (o != null);
        Iterator iter = (Iterator) o;

        return (this.stringify(iter, mDelim, mElementStringifier));
    }


    /*
     * Subclass may choose to override this.
     */
    protected abstract void stringifyElement(Object elem, String delim, StringBuilder buf);

    public String stringify(Iterator iter, String delim, Stringifier stringifier) {
        assert (iter != null);

        StringBuilder buf = new StringBuilder();

        while (iter.hasNext()) {
            final Object elem = iter.next();

            stringifyElement(elem, delim, buf);
            buf.append(delim);
        }

        // strip trailing delimiter
        final int length = buf.length();
        if (length != 0) {
            buf.setLength(length - delim.length());
        }

        return (buf.toString());
    }
}