openjpa-lib/src/main/java/org/apache/openjpa/lib/conf/StringListValue.java

/*
 * 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.openjpa.lib.conf;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;

import org.apache.openjpa.lib.util.Localizer;
import org.apache.openjpa.lib.util.ParseException;
import org.apache.openjpa.lib.util.StringUtil;

/**
 * A comma-separated list of string values.
 *
 * @author Abe White
 */
public class StringListValue extends Value {

    public static final String[] EMPTY = new String[0];
    private static final Localizer s_loc = Localizer.forPackage
        (StringListValue.class);

    private String[] _values = EMPTY;

    public StringListValue(String prop) {
        super(prop);
    }

    /**
     * The internal value.
     */
    public void set(String[] values) {
        assertChangeable();
        _values = (values == null) ? EMPTY : values;
        valueChanged();
    }

    /**
     * The internal value.
     */
    @Override
    public String[] get() {
        return _values;
    }

    @Override
    public Class<String []> getValueType() {
        return String[].class;
    }

    /**
     * Unalias the value list.  This method defers to super.unalias()
     * UNLESS the string passed is a list of values for a property that
     * has aliases.
     */
    @Override
    public String unalias(String str) {

        // defer to super.unalias
        String[] aliases = getAliases();
        if (aliases.length <= 0 || str == null)
            return super.unalias(str);
        str = str.trim();
        if (str.length() <= 0)
            return super.unalias(str);

        // snag this case early as it only causes problems
        if (str.equals(","))
            throw new ParseException(s_loc.get("invalid-list-config",
                getProperty(), str, getAliasList()));

        // unalias the list and concatenate the list of
        // canonical values.  Also, catch any bad aliases.
        boolean found;
        String iString;
        StringBuilder retv = new StringBuilder();
        String[] vals = str.split(",", 0);

        for (int i = 0; i < vals.length; i++) {
            iString = vals[i] = vals[i].trim();

            found = false;
            if (i > 0)
                retv.append(',');

            for (int x = 0; x < aliases.length; x += 2)
                if (Objects.equals(iString, aliases[x])
                    || Objects.equals(iString, aliases[x + 1])) {
                    retv.append(aliases[x + 1]);
                    found = true;
                    break;
                }

            // If the alias list is not comprehensive, add any unknown
            // values back onto the list
            if (!found) {
                if (isAliasListComprehensive())
                    throw new ParseException(s_loc.get("invalid-list-config",
                        getProperty(), str, getAliasList()));
                else
                    retv.append(iString);
            }
        }
        return retv.toString();
    }

    @Override
    protected String getInternalString() {
        return StringUtil.join(_values, ", ");
    }

    @Override
    protected void setInternalString(String val) {
        String[] vals = StringUtil.split(val, ",", 0);
        if (vals != null) {
            for (int i = 0; i < vals.length; i++)
                vals[i] = vals[i].trim();
        }

        set(vals);
    }

    @Override
    protected void setInternalObject(Object obj) {
        set((String[]) obj);
    }

    protected List<String> getAliasList() {
        return Arrays.asList(getAliases());
    }

}