com.mooltiverse.oss.nyx.version.CompositeIdentifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java Show documentation
com.mooltiverse.oss.nyx:java:3.0.6 All the Nyx Java artifacts
The newest version!
/*
 * Copyright 2020 Mooltiverse
 *
 * 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.mooltiverse.oss.nyx.version;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

/**
 * An identifier holding multiple child identifiers.
 */
abstract class CompositeIdentifier extends Identifier {
    /**
     * Serial version UID to comply with {@link java.io.Serializable}
     */
    private static final long serialVersionUID = 1L;

    /**
     * The nested identifiers.
     */
    protected final List children;

    /**
     * Store the immutable string representation after the first rendering to avoid repetitive formatting.
     */
    private transient String renderedString = null;

    /**
     * The separator among children values in the string representation.
     *
     * @see #DEFAULT_SEPARATOR
     */
    protected final char separator;

    /**
     * The default separator used in the string representation if no other is specified.
     *
     * @see #separator
     */
    public static final char DEFAULT_SEPARATOR = '.';

    /**
     * Builds the identifier with the given nested identifiers and separator.
     *
     * @param separator the separator used for the string representation to separate children values
     * @param children the children of this composite identifier. It can't be {@code null} or contain {@code null} values
     *
     * @throws NullPointerException if the given list of children is {@code null} or contains {@code null} values
     * @throws IllegalArgumentException if the given list of children contains illegal values
     */
    @SafeVarargs
    protected CompositeIdentifier(char separator, Identifier... children) {
        super();
        this.separator = separator;
        this.children = Parser.validateElements(Arrays.asList(children));
    }

    /**
     * Builds the identifier with the given nested identifiers and the default separator.
     *
     * @param children the children of this composite identifier. It can't be {@code null} or contain {@code null} values
     *
     * @throws NullPointerException if the given list of children is {@code null} or contains {@code null} values
     * @throws IllegalArgumentException if the given list of children contains illegal values
     */
    @SafeVarargs
    protected CompositeIdentifier(Identifier... children) {
        this(DEFAULT_SEPARATOR, children);
    }

    /**
     * Builds the identifier with the given nested identifiers and separator.
     *
     * @param separator the separator used for the string representation to separate children values
     * @param children the children of this composite identifier. It can't be {@code null} or contain {@code null} values
     *
     * @throws NullPointerException if the given list of children is {@code null} or contains {@code null} values
     * @throws IllegalArgumentException if the given list of children contains illegal values
     */
    protected CompositeIdentifier(char separator, List children) {
        super();
        this.separator = separator;
        this.children = Parser.validateElements(children);
    }

    /**
     * Builds the identifier with the given nested identifiers and the default separator.
     *
     * @param children the children of this composite identifier. It can't be {@code null} or contain {@code null} values
     *
     * @throws NullPointerException if the given list of children is {@code null} or contains {@code null} values
     * @throws IllegalArgumentException if the given list of children contains illegal values
     */
    protected CompositeIdentifier(List children) {
        this(DEFAULT_SEPARATOR, children);
    }

    /**
     * Returns the underlying list of identifiers, children of this composite identifier
     * 
     * @return the underlying list of identifiers
     * 
     * @see #getValues()
     */
    public List getValue() {
        return children;
    }

    /**
     * Returns the list of values held by child identifiers
     * 
     * @return the underlying list of values
     * 
     * @see #getValue()
     */
    public List