io.protostuff.parser

Class DefaultProtoLoader

java.lang.Object

io.protostuff.parser.DefaultProtoLoader

All Implemented Interfaces:

Proto.Loader

public class DefaultProtoLoader
extends Object
implements Proto.Loader

Default proto loader for imported protos.

Author:

David Yu

Date created:

May 16, 2010

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ALL
static DefaultProtoLoader	DEFAULT_INSTANCE
static int	DEFAULT_PROTO_SEARCH_STRATEGY The default proto search strategy to use.
static String	PATH_SEPARATOR Standard JVM property.
static String	PATH_SEPARATOR_PROPERTY
protected static int	PROTO_PATH_AND_CLASSPATH
protected static int	PROTO_PATH_ONLY
protected int	protoSearchStrategy

Constructor Summary

Constructors

Constructor and Description
DefaultProtoLoader()
DefaultProtoLoader(int protoSearchStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultProtoLoader	getDefaultInstance()
static URL	getResource(String resource, Class<?> context) Loads a URL resource from the classloader; If not found, the classloader of the context class specified will be used.
static URL	getResource(String resource, Class<?> context, boolean checkParent) Loads a URL resource from the classloader; If not found, the classloader of the context class specified will be used.
Proto	load(String path, Proto importer)
protected Proto	loadFrom(File file, Proto importer)
protected Proto	loadFrom(URL resource, Proto importer)
static Proto	loadFromClasspath(String path, Proto importer) Loads a proto from the classpath.
protected Proto	loadFromOtherResource(String path, Proto importer)
protected Proto	searchFromAll(String path, Proto importer) Search from every possible resource.
protected Proto	searchFromProtoPathAndClasspath(String path, Proto importer) Search from proto_path and classpath (in that order).
protected Proto	searchFromProtoPathOnly(String path, Proto importer) Search from proto_path only.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

protected static final int ALL

See Also:

Constant Field Values

PROTO_PATH_ONLY

protected static final int PROTO_PATH_ONLY

See Also:

Constant Field Values

PROTO_PATH_AND_CLASSPATH

protected static final int PROTO_PATH_AND_CLASSPATH

See Also:

Constant Field Values

DEFAULT_PROTO_SEARCH_STRATEGY

public static final int DEFAULT_PROTO_SEARCH_STRATEGY

The default proto search strategy to use.

PATH_SEPARATOR

public static final String PATH_SEPARATOR

Standard JVM property. See https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html

PATH_SEPARATOR_PROPERTY

public static final String PATH_SEPARATOR_PROPERTY

See Also:

Constant Field Values

DEFAULT_INSTANCE

public static final DefaultProtoLoader DEFAULT_INSTANCE

protoSearchStrategy

protected final int protoSearchStrategy

Constructor Detail

DefaultProtoLoader

public DefaultProtoLoader()

DefaultProtoLoader

public DefaultProtoLoader(int protoSearchStrategy)

Method Detail

getDefaultInstance

public static DefaultProtoLoader getDefaultInstance()

load

public Proto load(String path,
         Proto importer)
           throws Exception

Specified by:

load in interface Proto.Loader

Throws:

Exception

searchFromProtoPathOnly

protected Proto searchFromProtoPathOnly(String path,
                            Proto importer)
                                 throws Exception

Search from proto_path only. For full protoc compatibility, use this.

 Enable via:
 -Dproto_path=$path -Dproto_search_strategy=1
 

Throws:

Exception

searchFromProtoPathAndClasspath

protected Proto searchFromProtoPathAndClasspath(String path,
                                    Proto importer)
                                         throws Exception

Search from proto_path and classpath (in that order).

 Enable via:
 -Dproto_path=$path -Dproto_search_strategy=2
 

Throws:

Exception

searchFromAll

protected Proto searchFromAll(String path,
                  Proto importer)
                       throws Exception

Search from every possible resource. Also loads from a remote url (if path starts with http://).

 Search order is:
 1. relative path
 2. proto_path
 3. classpath
 

Throws:

Exception

loadFromOtherResource

protected Proto loadFromOtherResource(String path,
                          Proto importer)
                               throws Exception

Throws:

Exception

loadFrom

protected Proto loadFrom(File file,
             Proto importer)
                  throws Exception

Throws:

Exception

loadFrom

protected Proto loadFrom(URL resource,
             Proto importer)
                  throws Exception

Throws:

Exception

loadFromClasspath

public static Proto loadFromClasspath(String path,
                      Proto importer)
                               throws Exception

Loads a proto from the classpath.

Throws:

Exception

getResource

public static URL getResource(String resource,
              Class<?> context)

Loads a URL resource from the classloader; If not found, the classloader of the context class specified will be used.

getResource

public static URL getResource(String resource,
              Class<?> context,
              boolean checkParent)

Loads a URL resource from the classloader; If not found, the classloader of the context class specified will be used. If the flag checkParent is true, the classloader's parent is included in the lookup.