org.opendaylight.yangtools.yang.data.api.FixedYangInstanceIdentifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation
YANG Tools documentation
There is a newer version: 14.0.4
/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.data.api;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;

import com.google.common.collect.ImmutableList;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.util.HashCodeBuilder;

final class FixedYangInstanceIdentifier extends YangInstanceIdentifier implements Cloneable {
    static final @NonNull FixedYangInstanceIdentifier EMPTY_INSTANCE = new FixedYangInstanceIdentifier(
        ImmutableList.of());
    @java.io.Serial
    private static final long serialVersionUID = 1L;

    private final @NonNull ImmutableList path;

    private transient volatile YangInstanceIdentifier parent = null;

    FixedYangInstanceIdentifier(final ImmutableList path) {
        this.path = requireNonNull(path, "path must not be null.");
    }

    @Override
    public boolean isEmpty() {
        return path.isEmpty();
    }

    @Override
    public FixedYangInstanceIdentifier clone() {
        try {
            return (FixedYangInstanceIdentifier) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("clone() should be supported", e);
        }
    }

    @Override
    public YangInstanceIdentifier getParent() {
        if (path.isEmpty()) {
            return null;
        }

        YangInstanceIdentifier ret = parent;
        if (ret == null) {
            ret = YangInstanceIdentifier.of(path.subList(0, path.size() - 1));
            parent = ret;
        }

        return ret;
    }

    @Override
    public YangInstanceIdentifier coerceParent() {
        return verifyNotNull(getParent(), "Empty instance identifier does not have a parent");
    }

    @Override
    public YangInstanceIdentifier getAncestor(final int depth) {
        checkArgument(depth >= 0, "Negative depth is not allowed");
        checkArgument(depth <= path.size(), "Depth %s exceeds maximum depth %s", depth, path.size());

        if (depth == path.size()) {
            return this;
        }
        if (depth == path.size() - 1) {
            // Use the parent cache
            return verifyNotNull(getParent());
        }
        return YangInstanceIdentifier.of(path.subList(0, depth));
    }

    @Override
    public ImmutableList getPathArguments() {
        return path;
    }

    @Override
    public ImmutableList getReversePathArguments() {
        return path.reverse();
    }

    @Override
    @NonNull ImmutableList tryPathArguments() {
        return path;
    }

    @Override
    @NonNull ImmutableList tryReversePathArguments() {
        return getReversePathArguments();
    }

    @Override
    public PathArgument getLastPathArgument() {
        return path.isEmpty() ? null : path.get(path.size() - 1);
    }

    @Override
    YangInstanceIdentifier createRelativeIdentifier(final int skipFromRoot) {
        return skipFromRoot == path.size() ? EMPTY_INSTANCE
            : new FixedYangInstanceIdentifier(path.subList(skipFromRoot, path.size()));
    }

    @Override
    int computeHashCode() {
        int ret = 1;
        for (PathArgument arg : path) {
            ret = HashCodeBuilder.nextHashCode(ret, arg);
        }
        return ret;
    }

    @Override
    public FixedYangInstanceIdentifier toOptimized() {
        return this;
    }
}