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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * 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 [2019] Payara Foundation and/or affiliates
package org.glassfish.admin.amx.util.stringifier;

import java.util.Arrays;
import java.util.Iterator;

/**
 * Stringifies an array, using an optional array element Stringifier
 */
public final class ArrayStringifier implements Stringifier {

    final String mDelim;
    final Stringifier mElementStringifier;
    boolean mAddBraces;

    static final char LEFT_BRACE = '{';
    static final char RIGHT_BRACE = '}';
    static final String DEFAULT_DELIM = ", ";

    public static final ArrayStringifier DEFAULT = new ArrayStringifier(",");

    public ArrayStringifier() {
        this(SmartStringifier.DEFAULT);
        mAddBraces = false;
    }

    public ArrayStringifier(boolean addBraces) {
        this(DEFAULT_DELIM, SmartStringifier.DEFAULT, addBraces);
    }

    public ArrayStringifier(String delim) {
        this(delim, false);
    }

    public ArrayStringifier(String delim, boolean addBraces) {
        this(delim, SmartStringifier.DEFAULT, addBraces);
    }

    public ArrayStringifier(Stringifier elementStringifier) {
        this(DEFAULT_DELIM, elementStringifier);
    }

    public ArrayStringifier(String delim, Stringifier elementStringifier) {
        this(delim, elementStringifier, false);
    }

    public ArrayStringifier(String delim, Stringifier elementStringifier, boolean addBraces) {
        mDelim = delim;
        mElementStringifier = elementStringifier;
        mAddBraces = addBraces;
    }

    static String
            addBraces(boolean add, String s) {
        String out = s;
        if (add) {
            out = LEFT_BRACE + s + RIGHT_BRACE;
        }
        return (out);
    }

    @Override
    public String stringify(Object o) {
        final String s = this.stringify((Object[]) o, mDelim, mElementStringifier);

        return (addBraces(mAddBraces, s));
    }

    /**
     * Static variant when direct call will suffice.
     */
    public static String stringify(Object[] o, String delim, Stringifier stringifier) {
        final Iterator iter = Arrays.asList(o).iterator();
        final IteratorStringifier iterStringifier = new IteratorStringifier(delim, stringifier);

        final String s = iterStringifier.stringify(iter);
        return (s);
    }

    /**
     * Static variant when direct call will suffice.
     */
    public static String stringify(Object[] o, String delim) {
        return (stringify(o, delim, SmartStringifier.DEFAULT));
    }

}