com.aspectran.utils.apon.AbstractParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-utils Show documentation
Miscellaneous utility classes used across multiple packages
There is a newer version: 8.1.3
/*
 * Copyright (c) 2008-2024 The Aspectran Project
 *
 * Licensed 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 com.aspectran.utils.apon;

import com.aspectran.utils.BooleanUtils;
import com.aspectran.utils.StringUtils;
import com.aspectran.utils.ToStringBuilder;
import com.aspectran.utils.annotation.jsr305.NonNull;

import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.lang.reflect.Array;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

public abstract class AbstractParameters implements Parameters {

    private final Map parameterValueMap;

    private final Map altParameterValueMap;

    private final Set parameterNames;

    private final boolean structureFixed;

    private Parameter proprietor;

    private String actualName;

    protected AbstractParameters(ParameterKey[] parameterKeys) {
        Map valueMap = new LinkedHashMap<>();
        if (parameterKeys != null) {
            Map altValueMap = new HashMap<>();
            Set parameterNames = new LinkedHashSet<>();
            for (ParameterKey pk : parameterKeys) {
                ParameterValue pv = pk.newParameterValue();
                pv.setContainer(this);
                valueMap.put(pk.getName(), pv);
                parameterNames.add(pk.getName());
                if (pk.getAltNames() != null) {
                    for (String altName : pk.getAltNames()) {
                        altValueMap.put(altName, pv);
                        parameterNames.add(altName);
                    }
                }
            }
            this.parameterValueMap = Collections.unmodifiableMap(valueMap);
            this.altParameterValueMap = (altValueMap.isEmpty() ?
                Collections.emptyMap() : Collections.unmodifiableMap(altValueMap));
            this.parameterNames = Collections.unmodifiableSet(parameterNames);
            this.structureFixed = true;
        } else {
            this.parameterValueMap = valueMap;
            this.altParameterValueMap = Collections.emptyMap();
            this.parameterNames = null;
            this.structureFixed = false;
        }
    }

    @Override
    public boolean isStructureFixed() {
        return structureFixed;
    }

    @Override
    public Parameter getProprietor() {
        return proprietor;
    }

    @Override
    public void setProprietor(Parameter proprietor) {
        this.proprietor = proprietor;
    }

    @Override
    public Parameter getParent() {
        if (proprietor != null && proprietor.getContainer() != null) {
            return proprietor.getContainer().getProprietor();
        } else {
            return null;
        }
    }

    @Override
    public String getActualName() {
        if (proprietor == null) {
            return actualName;
        }
        return (actualName != null ? actualName : proprietor.getName());
    }

    @Override
    public void setActualName(String actualName) {
        this.actualName = actualName;
    }

    @Override
    public String getQualifiedName() {
        if (proprietor != null) {
            return proprietor.getQualifiedName();
        }
        return this.getClass().getName();
    }

    @Override
    public ParameterValue getParameterValue(String name) {
        if (name == null) {
            throw new IllegalArgumentException("name must not be null");
        }
        ParameterValue pv = parameterValueMap.get(name);
        if (pv != null) {
            return pv;
        }
        if (structureFixed) {
            return altParameterValueMap.get(name);
        }
        return null;
    }

    @Override
    @NonNull
    public Map getParameterValueMap() {
        return parameterValueMap;
    }

    @Override
    @NonNull
    public String[] getParameterNames() {
        return getParameterNameSet().toArray(new String[0]);
    }

    @Override
    @NonNull
    public Set getParameterNameSet() {
        if (parameterNames != null) {
            return parameterNames;
        } else {
            return parameterValueMap.keySet();
        }
    }

    @Override
    public boolean hasParameter(String name) {
        return (parameterValueMap.containsKey(name) || structureFixed && altParameterValueMap.containsKey(name));
    }

    @Override
    public boolean hasParameter(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return hasParameter(key.getName());
    }

    @Override
    public boolean isAssigned(String name) {
        Parameter p = getParameterValue(name);
        return (p != null && p.isAssigned());
    }

    @Override
    public boolean isAssigned(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return isAssigned(key.getName());
    }

    @Override
    public boolean hasValue(String name) {
        Parameter p = getParameterValue(name);
        return (p != null && p.hasValue());
    }

    @Override
    public boolean hasValue(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        Parameter p = getParameterValue(key.getName());
        return (p != null && p.hasValue());
    }

    @Override
    public Parameter getParameter(String name) {
        Parameter p = getParameterValue(name);
        if (p == null && structureFixed) {
            throw new UnknownParameterException(name, this);
        }
        return p;
    }

    @Override
    public Parameter getParameter(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getParameter(key.getName());
    }

    @Override
    public Object getValue(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValue() : null);
    }

    @Override
    public Object getValue(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getValue(key.getName());
    }

    @Override
    public void setValue(String name, Object value) {
        removeValue(name);
        putValue(name, value);
    }

    @Override
    public void setValue(ParameterKey key, Object value) {
        removeValue(key);
        putValue(key, value);
    }

    @Override
    public void putAll(Parameters parameters) {
        if (parameters == null) {
            throw new IllegalArgumentException("parameters must not be null");
        }
        if (structureFixed) {
            throw new IllegalStateException();
        }
        for (ParameterValue parameterValue : parameters.getParameterValueMap().values()) {
            parameterValue.setContainer(this);
        }
        parameterValueMap.putAll(parameters.getParameterValueMap());
    }

    @Override
    public void putValue(String name, Object value) {
        Parameter p = getParameter(name);
        if (p == null) {
            p = newParameterValue(name, ValueType.determineValueType(value));
        }
        if (value != null && value.getClass().isArray()) {
            if (structureFixed && !p.isArray()) {
                throw new IllegalStateException("Not a parameter of array type: " + p);
            }
            int len = Array.getLength(value);
            for (int i = 0; i < len; i++) {
                Object obj = Array.get(value, i);
                putValue(p, name, obj);
            }
        } else if (value instanceof Collection collection) {
            for (Object obj : collection) {
                putValue(p, name, obj);
            }
        } else {
            putValue(p, name, value);
        }
    }

    private void putValue(@NonNull Parameter p, String name, Object value) {
        p.putValue(value);
        if (value instanceof Parameters parameters) {
            parameters.setActualName(name);
            parameters.updateContainer(this);
        }
    }

    @Override
    public void putValue(ParameterKey key, Object value) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        putValue(key.getName(), value);
    }

    @Override
    public void putValueNonNull(String name, Object value) {
        if (value != null) {
            putValue(name, value);
        }
    }

    @Override
    public void putValueNonNull(ParameterKey key, Object value) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        if (value != null) {
            putValue(key.getName(), value);
        }
    }

    @Override
    public void removeValue(String name) {
        if (name == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        if (structureFixed) {
            Parameter p = getParameter(name);
            if (p != null) {
                p.removeValue();
            }
        } else {
            parameterValueMap.remove(name);
        }
    }

    @Override
    public void removeValue(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        removeValue(key.getName());
    }

    @Override
    public String getString(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsString() : null);
    }

    @Override
    public String getString(String name, String defaultValue) {
        String s = getString(name);
        return (s != null ? s : defaultValue);
    }

    @Override
    public String getString(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getString(key.getName());
    }

    @Override
    public String getString(ParameterKey key, String defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getString(key.getName(), defaultValue);
    }

    @Override
    public String[] getStringArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsStringArray() : null);
    }

    @Override
    public String[] getStringArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getStringArray(key.getName());
    }

    @Override
    public List getStringList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsStringList() : null);
    }

    @Override
    public List getStringList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getStringList(key.getName());
    }

    @Override
    public Integer getInt(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsInt() : null);
    }

    @Override
    public int getInt(String name, int defaultValue) {
        Parameter p = getParameter(name);
        if (p != null) {
            Integer val = p.getValueAsInt();
            return (val != null ? val : defaultValue);
        }
        return defaultValue;
    }

    @Override
    public Integer[] getIntArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsIntArray() : null);
    }

    @Override
    public Integer getInt(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getInt(key.getName());
    }

    @Override
    public int getInt(ParameterKey key, int defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getInt(key.getName(), defaultValue);
    }

    @Override
    public Integer[] getIntArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getIntArray(key.getName());
    }

    @Override
    public List getIntList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsIntList() : null);
    }

    @Override
    public List getIntList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getIntList(key.getName());
    }

    @Override
    public Long getLong(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsLong() : null);
    }

    @Override
    public long getLong(String name, long defaultValue) {
        Parameter p = getParameter(name);
        if (p != null) {
            Long val = p.getValueAsLong();
            return (val != null ? val : defaultValue);
        }
        return defaultValue;
    }

    @Override
    public Long getLong(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getLong(key.getName());
    }

    @Override
    public long getLong(ParameterKey key, long defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getLong(key.getName(), defaultValue);
    }

    @Override
    public Long[] getLongArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsLongArray() : null);
    }

    @Override
    public Long[] getLongArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getLongArray(key.getName());
    }

    @Override
    public List getLongList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsLongList() : null);
    }

    @Override
    public List getLongList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getLongList(key.getName());
    }

    @Override
    public Float getFloat(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsFloat() : null);
    }

    @Override
    public float getFloat(String name, float defaultValue) {
        Parameter p = getParameter(name);
        if (p != null) {
            Float val = p.getValueAsFloat();
            return (val != null ? val : defaultValue);
        }
        return defaultValue;
    }

    @Override
    public Float getFloat(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getFloat(key.getName());
    }

    @Override
    public float getFloat(ParameterKey key, float defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getFloat(key.getName(), defaultValue);
    }

    @Override
    public Float[] getFloatArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsFloatArray() : null);
    }

    @Override
    public Float[] getFloatArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getFloatArray(key.getName());
    }

    @Override
    public List getFloatList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsFloatList() : null);
    }

    @Override
    public List getFloatList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getFloatList(key.getName());
    }

    @Override
    public Double getDouble(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsDouble() : null);
    }

    @Override
    public double getDouble(String name, double defaultValue) {
        Parameter p = getParameter(name);
        if (p != null) {
            Double val = p.getValueAsDouble();
            return (val != null ? val : defaultValue);
        }
        return defaultValue;
    }

    @Override
    public Double getDouble(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getDouble(key.getName());
    }

    @Override
    public double getDouble(ParameterKey key, double defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getDouble(key.getName(), defaultValue);
    }

    @Override
    public Double[] getDoubleArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsDoubleArray() : null);
    }

    @Override
    public Double[] getDoubleArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getDoubleArray(key.getName());
    }

    @Override
    public List getDoubleList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsDoubleList() : null);
    }

    @Override
    public List getDoubleList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getDoubleList(key.getName());
    }

    @Override
    public Boolean getBoolean(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsBoolean() : null);
    }

    @Override
    public boolean getBoolean(String name, boolean defaultValue) {
        Parameter p = getParameter(name);
        return (p != null ? BooleanUtils.toBoolean(p.getValueAsBoolean(), defaultValue) : defaultValue);
    }

    @Override
    public Boolean getBoolean(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getBoolean(key.getName());
    }

    @Override
    public boolean getBoolean(ParameterKey key, boolean defaultValue) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getBoolean(key.getName(), defaultValue);
    }

    @Override
    public Boolean[] getBooleanArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsBooleanArray() : null);
    }

    @Override
    public Boolean[] getBooleanArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getBooleanArray(key.getName());
    }

    @Override
    public List getBooleanList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? p.getValueAsBooleanList() : null);
    }

    @Override
    public List getBooleanList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getBooleanList(key.getName());
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T getParameters(String name) {
        Parameter p = getParameter(name);
        return (p != null ? (T)p.getValue() : null);
    }

    @Override
    public  T getParameters(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getParameters(key.getName());
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T[] getParametersArray(String name) {
        Parameter p = getParameter(name);
        return (p != null ? (T[])p.getValueAsParametersArray() : null);
    }

    @Override
    public  T[] getParametersArray(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getParametersArray(key.getName());
    }

    @Override
    @SuppressWarnings("unchecked")
    public  List getParametersList(String name) {
        Parameter p = getParameter(name);
        return (p != null ? (List)p.getValueAsParametersList() : null);
    }

    @Override
    public  List getParametersList(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return getParametersList(key.getName());
    }

    @Override
    public ParameterValue newParameterValue(String name, ValueType valueType) {
        return newParameterValue(name, valueType, false);
    }

    @Override
    public ParameterValue newParameterValue(String name, ValueType valueType, boolean array) {
        if (structureFixed) {
            throw new IllegalStateException("Unknown parameter: " + name);
        }
        ParameterValue pv = new ParameterValue(name, valueType, array);
        pv.setContainer(this);
        parameterValueMap.put(name, pv);
        return pv;
    }

    @Override
    public  T newParameters(String name) {
        Parameter p = getParameter(name);
        if (structureFixed) {
            if (p == null) {
                throw new UnknownParameterException(name, this);
            }
        } else {
            if (p == null) {
                p = newParameterValue(name, ValueType.PARAMETERS);
            }
        }
        T ps = p.newParameters(p);
        ps.setActualName(name);
        return ps;
    }

    @Override
    public  T newParameters(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return newParameters(key.getName());
    }

    @Override
    @SuppressWarnings("unchecked")
    public  T touchParameters(String name) {
        Parameters parameters = getParameters(name);
        if (parameters == null) {
            parameters = newParameters(name);
        }
        return (T)parameters;
    }

    @Override
    public  T touchParameters(ParameterKey key) {
        if (key == null) {
            throw new IllegalArgumentException("key must not be null");
        }
        return touchParameters(key.getName());
    }

    @Override
    public void updateContainer(@NonNull Parameters container) {
        for (ParameterValue parameterValue : container.getParameterValueMap().values()) {
            parameterValue.setContainer(container);
        }
    }

    @Override
    public void readFrom(String apon) throws AponParseException {
        if (apon != null) {
            AponReader.parse(apon, this);
        }
    }

    @Override
    public void readFrom(VariableParameters parameters) throws AponParseException {
        if (parameters != null) {
            readFrom(parameters.toString());
        }
    }

    @Override
    public void readFrom(File file) throws AponParseException {
        if (file != null) {
            AponReader.parse(file, this);
        }
    }

    @Override
    public void readFrom(File file, String encoding) throws AponParseException {
        if (file != null) {
            AponReader.parse(file, encoding, this);
        }
    }

    @Override
    public void readFrom(Reader reader) throws AponParseException {
        if (reader != null) {
            AponReader.parse(reader, this);
        }
    }

    @Override
    public String describe() {
        return describe(false);
    }

    @Override
    public String describe(boolean details) {
        ToStringBuilder tsb = new ToStringBuilder();
        tsb.append("qualifiedName", getQualifiedName());
        if (details) {
            tsb.append("parameters", parameterValueMap);
            if (structureFixed && !altParameterValueMap.isEmpty()) {
                tsb.append("altParameters", altParameterValueMap);
            }
        } else {
            tsb.append("parameters", getParameterNames());
        }
        tsb.append("class", getClass().getName());
        tsb.append("parent", getParent());
        return tsb.toString();
    }

    @Override
    public String toString() {
        try {
            return new AponWriter().nullWritable(false).write(this).toString();
        } catch (IOException e) {
            return StringUtils.EMPTY;
        }
    }

}