io.openapiparser.model.v31.Reference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation

OpenAPI 3.0/3.1 parser

The newest version!

/*
 * Copyright 2021 https://github.com/openapi-processor/openapi-parser
 * PDX-License-Identifier: Apache-2.0
 */

package io.openapiparser.model.v31;

import io.openapiprocessor.jsonschema.converter.NoValueException;
import io.openapiparser.support.Required;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * the Reference object.
 *
 * See specification:
 * 4.8.23 Reference Object
 */
public interface Reference {

    /**
     * check if this is a $ref object.
     *
     * @return true if $ref else false.
     */
    boolean isRef ();

    /**
     * $ref value. Should be guarded by {@link #isRef()}. Throws if {@link #isRef()} is false.
     *
     * @return ref
     * @throws NoValueException if {@link #isRef()} is false
     *
     * // todo do not throw, let getRefObject() throw
     */
    @Required
    String getRef ();

    @Nullable String getSummary();

    @Nullable String getDescription();
}