Package org.eclipse.lemminx.extensions.contentmodel.model

Class ReferencedGrammarInfo

java.lang.Object

org.eclipse.lemminx.extensions.contentmodel.model.ReferencedGrammarInfo

public class ReferencedGrammarInfo
extends Object

Class which holds a referenced grammar information.

In other words, it gives information about

• which XSD, DTD file is bound to the DOM document.
• which binding strategies is used (catalog, file association, xsi:schemaLocation, xsi:noNamespaceSchemaLocation, DOCTYPE).
• the cache file path (for remote grammar with http://)

Constructor Summary

Constructors

Constructor	Description
ReferencedGrammarInfo(ResolvedURIInfo resolvedURIInfo, GrammarCacheInfo grammarCacheInfo, ContentModelProvider.Identifier identifier)

Method Summary

Modifier and Type	Method	Description
String	getBindingKind()	Returns the binding kind and null otherwise.
static String	getBindingKindAndResolvedBy(ReferencedGrammarInfo info)	Returns the binding kind and resolved by label.
GrammarCacheInfo	getGrammarCacheInfo()	Returns the grammar cache information and null otherwise.
ContentModelProvider.Identifier	getIdentifier()	Returns the identifier (xml-model, xsi:schemaLocation, xsi:noNamespaceSchemaLocation, DOCTYPE) and null otherwise.
String	getIdentifierURI()	Returns the system or public identifier URI and null otherwise.
String	getResolvedBy()	Returns the resolver which is used to resolve the identifier URI and null otherwise.
ResolvedURIInfo	getResolvedURIInfo()	Returns the resolved URI information (the result of the resolve and the resolution strategy (ex : catalog, file association, etc)).
boolean	isInCache()	Returns true if the grammar is in the .lemminx cache and false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferencedGrammarInfo

public ReferencedGrammarInfo(ResolvedURIInfo resolvedURIInfo,
                             GrammarCacheInfo grammarCacheInfo,
                             ContentModelProvider.Identifier identifier)

Method Detail

getResolvedURIInfo

public ResolvedURIInfo getResolvedURIInfo()

Returns the resolved URI information (the result of the resolve and the resolution strategy (ex : catalog, file association, etc)).

Returns:

the resolved URI information (the result of the resolve and the resolution strategy

getGrammarCacheInfo

public GrammarCacheInfo getGrammarCacheInfo()

Returns the grammar cache information and null otherwise. (grammar is not a remote grammar with http://)

Returns:

the grammar cache information and null otherwise.

getIdentifier

public ContentModelProvider.Identifier getIdentifier()

Returns the identifier (xml-model, xsi:schemaLocation, xsi:noNamespaceSchemaLocation, DOCTYPE) and null otherwise.

Returns:

the identifier (xml-model, xsi:schemaLocation, xsi:noNamespaceSchemaLocation, DOCTYPE) and null otherwise.

isInCache

public boolean isInCache()

Returns true if the grammar is in the .lemminx cache and false otherwise.

Returns:

true if the grammar is in the .lemminx cache and false otherwise.

getIdentifierURI

public String getIdentifierURI()

Returns the system or public identifier URI and null otherwise.

Returns:

the system or public identifier URI and null otherwise.

getBindingKind

public String getBindingKind()

Returns the binding kind and null otherwise. Binding kind can have values:

• xsi:schemaLocation
• xsi:noNamespaceSchemaLocation
• doctype
• xml-model

Returns:

the binding kind and null otherwise.

getResolvedBy

public String getResolvedBy()

Returns the resolver which is used to resolve the identifier URI and null otherwise. Resolved by can have values:

• catalog
• file association
• embedded catalog.xsd
• embedded xml.xsd
• embedded xslt.xsd

Returns:

the resolver which is used to resolve the identifier URI and null otherwise.

getBindingKindAndResolvedBy

public static String getBindingKindAndResolvedBy(ReferencedGrammarInfo info)

Returns the binding kind and resolved by label.

Parameters:

info - the referenced grammar information.

Returns:

the binding kind and resolved by label.