Package org.infinispan.protostream

Class FileDescriptorSource

java.lang.Object

org.infinispan.protostream.FileDescriptorSource

public final class FileDescriptorSource
extends Object

Aggregator for source proto files to be passed to SerializationContext.registerProtoFiles(FileDescriptorSource). The files are guaranteed to be processed in the order they were added (for better predictability or error reporting).

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileDescriptorSource.ProgressCallback	A callback interface that receives status notifications during the processing of files defined by a FileDescriptorSource.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	files	The unparsed files.
private FileDescriptorSource.ProgressCallback	progressCallback	Optional progress callback.

Constructor Summary

Constructors

Constructor	Description
FileDescriptorSource()

Method Summary

Modifier and Type	Method	Description
FileDescriptorSource	addProtoFile(File protoFile)
FileDescriptorSource	addProtoFile(String name, File protoFile)	Add a proto file, given a name and the file contents as a File.
FileDescriptorSource	addProtoFile(String name, InputStream fileContents)	Add a proto file, given a name and the file contents as an InputStream.
FileDescriptorSource	addProtoFile(String name, Reader fileContents)	Add a proto file, given a name and the file contents as a Reader.
FileDescriptorSource	addProtoFile(String name, String fileContents)	Add a proto file, given a name and the file contents as a String.
FileDescriptorSource	addProtoFiles(ClassLoader userClassLoader, String... classpathResources)	Add proto files from class path.
FileDescriptorSource	addProtoFiles(String... classpathResources)	Add proto files from class path.
static FileDescriptorSource	fromResources(ClassLoader userClassLoader, String... classPathResources)
static FileDescriptorSource	fromResources(String... classPathResources)
static FileDescriptorSource	fromString(String name, String fileContents)
Map<String,char[]>	getFileDescriptors()	Deprecated. This method was added for internal use and is deprecated since 4.3.4 to be removed in 5.
Map<String,String>	getFiles()
FileDescriptorSource.ProgressCallback	getProgressCallback()
static String	getResourceAsString(Class<?> c, String resourcePath)	Deprecated. This method is strictly for internal use and has been deprecated in 4.3.4 to prevent use from external projects as it is subject for removal in 5.
FileDescriptorSource	withProgressCallback(FileDescriptorSource.ProgressCallback progressCallback)	Set the ProgressCallback.

Methods inherited from class java.lang.Object

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

Field Details

files

private final Map<String,String> files

The unparsed files. Using a LinkedHashMap to ensure parsing happens in the order specified by the user so the eventual errors will appear in a predictable order.

progressCallback

private FileDescriptorSource.ProgressCallback progressCallback

Optional progress callback. If non-null it will be invoked based on the status of each parsed file.

Constructor Details

FileDescriptorSource

public FileDescriptorSource()

Method Details

withProgressCallback

public FileDescriptorSource withProgressCallback(FileDescriptorSource.ProgressCallback progressCallback)

Set the ProgressCallback. A null callback indicates that errors are to be reported immediately and the parsing operation should be aborted on first error.

Parameters:

progressCallback - the callback, can be null

Returns:

this object, for easy method chaining

addProtoFiles

public FileDescriptorSource addProtoFiles(String... classpathResources)
                                   throws IOException

Add proto files from class path. The resource names are expected to be absolute.

Throws:

IOException

addProtoFiles

public FileDescriptorSource addProtoFiles(ClassLoader userClassLoader,
 String... classpathResources)
                                   throws IOException

Add proto files from class path. The resource names are expected to be absolute.

Throws:

IOException

addProtoFile

public FileDescriptorSource addProtoFile(String name,
 String fileContents)

Add a proto file, given a name and the file contents as a String.

addProtoFile

public FileDescriptorSource addProtoFile(String name,
 InputStream fileContents)
                                  throws IOException

Add a proto file, given a name and the file contents as an InputStream.

Throws:

IOException

addProtoFile

public FileDescriptorSource addProtoFile(String name,
 Reader fileContents)
                                  throws IOException

Add a proto file, given a name and the file contents as a Reader.

Throws:

IOException

addProtoFile

public FileDescriptorSource addProtoFile(String name,
 File protoFile)
                                  throws IOException

Add a proto file, given a name and the file contents as a File.

Throws:

IOException

addProtoFile

public FileDescriptorSource addProtoFile(File protoFile)
                                  throws IOException

Throws:

IOException

fromResources

public static FileDescriptorSource fromResources(ClassLoader userClassLoader,
 String... classPathResources)
                                          throws IOException

Throws:

IOException

fromResources

public static FileDescriptorSource fromResources(String... classPathResources)
                                          throws IOException

Throws:

IOException

fromString

public static FileDescriptorSource fromString(String name,
 String fileContents)

getFileDescriptors

@Deprecated
public Map<String,char[]> getFileDescriptors()

Deprecated.

This method was added for internal use and is deprecated since 4.3.4 to be removed in 5. Replaced by getFiles()

getFiles

public Map<String,String> getFiles()

getProgressCallback

public FileDescriptorSource.ProgressCallback getProgressCallback()

getResourceAsString

@Deprecated
public static String getResourceAsString(Class<?> c,
 String resourcePath)
                                  throws UncheckedIOException

Deprecated.

This method is strictly for internal use and has been deprecated in 4.3.4 to prevent use from external projects as it is subject for removal in 5.

Finds a resource with a given path relative to a given Class and returns it as a String.

Throws:

UncheckedIOException - if the resource is not found or an I/O error occurs