io.openapiprocessor.jsonschema.schema.Reference Maven / Gradle / Ivy

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

package io.openapiprocessor.jsonschema.schema;

import org.checkerframework.checker.nullness.qual.Nullable;

import java.net.URI;

/**
 * resolved $ref.
 *
 * 
 *   $ref string must be an uri.
 *   
 *     fragment of $ref is a json pointer
 *     ('~' encoded as '~0', '/' encoded as '~1').
 *   
 * 
 */
public class Reference {
    private final Ref ref;
    private final RefValue value;

    public Reference (Ref ref, RefValue value) {
        this.ref = ref;
        this.value = value;
    }

    /**
     * the uri of the referenced document.
     *
     * @return the referenced document.
     */
    public URI getDocumentUri () {
        return ref.getDocumentUri ();
    }

    /**
     * get full ref uri with scope and json pointer.
     *
     * @return the full ref uri
     */
    public URI getAbsoluteRefUri () {
        return ref.getAbsoluteUri ();
    }

    /**
     * the value of the reference.
     *
     * @return $ref value
     */
    public String getRefValue () {
        return ref.getRef ();
    }

    /**
     * the scope at the reference value.
     *
     * @return scope of $ref
     */
    public Scope getValueScope () {
        return value.getScope ();
    }

    /**
     * the raw value of the reference. Maybe a simple value, array or map.
     *
     * @return the raw value.
     */
    public @Nullable Object getRawValue () {
        return value.getValue ();
    }

    @SuppressWarnings ({"unchecked", "TypeParameterUnusedInFormals"})
    public  @Nullable T getValue () {
        return (T) value.getValue ();
    }

    public JsonPointer getPointer() {
        return JsonPointer.from (ref.getPointer ());
    }

    @Override
    public String toString () {
        return ref.toString ();
    }

    private static String createRefRelative (String ref) {
        final int hash = ref.indexOf ("#");
        if (hash != -1) {
            return ref.substring (hash + 1);
        }

        return "";
    }
}