org.opendaylight.yangtools.yang.xpath.api.QNameReferent Maven / Gradle / Ivy

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) 2019 PANTHEON.tech, s.r.o.  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.xpath.api;

import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.AbstractQName;

/**
 * An object referencing a QName, either resolved or unresolved.
 */
public sealed interface QNameReferent extends Immutable
        permits ResolvedQNameReferent, UnresolvedQNameReferent, YangQNameExpr, YangLocationPath.QNameStep {
    /**
     * Return the referenced {@link AbstractQName}.
     *
     * @return An AbstractQName
     */
    AbstractQName getQName();

    /**
     * Return local name part of the referenced QName.
     *
     * @return Local name string.
     */
    default String getLocalName() {
        return getQName().getLocalName();
    }
}