org.opendaylight.yangtools.yang.parser.repo

Class URLSchemaContextResolver

java.lang.Object

org.opendaylight.yangtools.yang.parser.repo.URLSchemaContextResolver

All Implemented Interfaces:

AutoCloseable, org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider<org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource>

@Beta
public class URLSchemaContextResolver
extends Object
implements AutoCloseable, org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider<org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource>

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static URLSchemaContextResolver	create(String name)
com.google.common.base.Optional<org.opendaylight.yangtools.yang.model.api.SchemaContext>	getSchemaContext() Try to parse all currently available yang files and build new schema context.
com.google.common.util.concurrent.CheckedFuture<org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource,org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException>	getSource(org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier sourceIdentifier)
URLRegistration	registerSource(URL url) Register a URL hosting a YANG Text file.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static URLSchemaContextResolver create(String name)

registerSource

public URLRegistration registerSource(URL url)
                               throws org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException,
                                      IOException,
                                      org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException

Register a URL hosting a YANG Text file.

Parameters:

url - URL

Throws:

org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException - When the YANG file is syntactically invalid

IOException - when the URL is not readable

org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException - When parsing encounters general error

getSchemaContext

public com.google.common.base.Optional<org.opendaylight.yangtools.yang.model.api.SchemaContext> getSchemaContext()

Try to parse all currently available yang files and build new schema context.

Returns:

new schema context iif there is at least 1 yang file registered and new schema context was successfully built.

getSource

public com.google.common.util.concurrent.CheckedFuture<org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource,org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException> getSource(org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier sourceIdentifier)

Specified by:

getSource in interface org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider<org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource>

close

public void close()

Specified by:

close in interface AutoCloseable