Package io.openapiprocessor.jsonschema.schema

Class Scope

java.lang.Object

io.openapiprocessor.jsonschema.schema.Scope

public class Scope
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Scope(java.net.URI documentUri, @Nullable java.net.URI id, SchemaVersion version)
Scope(java.net.URI documentUri, SchemaVersion version)

Method Summary

Modifier and Type	Method	Description
static Scope	createScope(java.net.URI documentUri)
static Scope	createScope(java.net.URI documentUri, java.lang.Object document, SchemaVersion fallback)	create the scope for the document.
static Scope	createScope(java.net.URI documentUri, java.lang.Object document, Scope currentScope)	create the scope for the document.
static Scope	empty()
java.net.URI	getBaseUri()
java.net.URI	getDocumentUri()
SchemaVersion	getVersion()
Scope	move(java.lang.Object document)
Scope	move(java.net.URI documentUri, java.lang.Object document)
Scope	resolve(java.lang.String id)
Scope	resolve(java.net.URI id)
java.net.URI	resolveAnchor(java.lang.String anchor)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Scope

public Scope(java.net.URI documentUri,
             SchemaVersion version)

Scope

public Scope(java.net.URI documentUri,
             @Nullable java.net.URI id,
             SchemaVersion version)

Method Detail

empty

public static Scope empty()

createScope

public static Scope createScope(java.net.URI documentUri,
                                java.lang.Object document,
                                SchemaVersion fallback)

create the scope for the document. If document contains an id, it is the base uri, otherwise the scope is the documentUri. If the documentUri matches a know json schema the result scope will use its version, otherwise it will use the fallback version.

Parameters:

documentUri - uri of the document

document - source document

fallback - fallback json schema version

Returns:

the scope of the document

createScope

public static Scope createScope(java.net.URI documentUri,
                                java.lang.Object document,
                                Scope currentScope)

create the scope for the document. If document contains an id, it is the base uri, otherwise the scope is the documentUri. If the documentUri matches a know json schema the result scope will use its version, otherwise it will use the fallback version.

Parameters:

documentUri - uri of the document

document - source document

currentScope - the current scope

Returns:

the scope of the document

createScope

public static Scope createScope(java.net.URI documentUri)

getDocumentUri

public java.net.URI getDocumentUri()

getBaseUri

public java.net.URI getBaseUri()

getVersion

public SchemaVersion getVersion()

resolve

public Scope resolve(java.lang.String id)

resolve

public Scope resolve(java.net.URI id)

resolveAnchor

public java.net.URI resolveAnchor(java.lang.String anchor)

move

public Scope move(java.net.URI documentUri,
                  java.lang.Object document)

move

public Scope move(java.lang.Object document)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object