Package com.gentics.api.lib.resolving
Interface StreamingResolvable
-
public interface StreamingResolvable
Interface forResolvable
instances, that support streaming of properties
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InputStream
getInputStream(String name, int n)
Get an input stream for reading the nth property value, if the property can be streamed and 0 <= n <getNumStreams(String)
int
getNumStreams(String name)
Get the number of streams available for the property with given name.Collection<String>
getStreamableProperties()
Get the names of the properties that can be streamedboolean
isStreamable(String name)
Check whether the property with given name can be streamed.
-
-
-
Method Detail
-
getStreamableProperties
Collection<String> getStreamableProperties()
Get the names of the properties that can be streamed- Returns:
- collection of property names
-
isStreamable
boolean isStreamable(String name)
Check whether the property with given name can be streamed.- Parameters:
name
- property name- Returns:
- true if the property can be streamed, false if not
-
getNumStreams
int getNumStreams(String name)
Get the number of streams available for the property with given name.- Parameters:
name
- property name- Returns:
- number of streams available (0 if the property cannot be streamed)
-
getInputStream
InputStream getInputStream(String name, int n) throws IOException, ArrayIndexOutOfBoundsException
Get an input stream for reading the nth property value, if the property can be streamed and 0 <= n <getNumStreams(String)
- Parameters:
name
- name of the propertyn
- index of the input stream (starting with 0)- Returns:
- input stream
- Throws:
IOException
- if the property cannot be streamedArrayIndexOutOfBoundsException
- if n is set inappropriately
-
-