Interface TextResult
- All Superinterfaces:
Result
- All Known Implementing Classes:
StringTextResult
A text result is result type which has been produced by a
By convention, it always implies the flavor
Not all
Job
and is processed by
actions
.By convention, it always implies the flavor
TEXT
.Not all
ResultAction
can handle each FileResult
, result flavors
define the kind of
information/data a FileResult
represents and actions will handle only results they support. A result can
be processed by more than one ResultAction
.- Since:
- taskplanner 3.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault List<ResultFlavor>
Defined the types of data this Result contains.getText()
Returns the content of the result in form of aString
.Returns the content of the result in form of anInputStream
with encodingStandardCharsets.UTF_8
.Get the MIME type this result has.Methods inherited from interface com.inet.taskplanner.server.api.result.Result
cleanup, supportsFlavor, supportsOneFlavorOf
-
Method Details
-
getText
Returns the content of the result in form of aString
. The actual interpretation of the content depends on the type as returned bygetTextContentType()
.- Returns:
- the content as
String
- Throws:
IOException
- thrown if the content is created on demand and the creation failed- Since:
- taskplanner 3.0
-
getTextContent
Returns the content of the result in form of anInputStream
with encodingStandardCharsets.UTF_8
. The actual interpretation of the content depends on the type as returned bygetTextContentType()
.- Returns:
- the content as
String
- Throws:
IOException
- thrown if the content is created on demand and the creation failed- Since:
- taskplanner 3.0
-
getTextContentType
Get the MIME type this result has.- Returns:
- the content type of this result. When
null
, 'text/plain' is to be used. - Throws:
Exception
- if the type is could not be determined due to an IO problem- Since:
- taskplanner 3.0
-
getFlavors
Defined the types of data this Result contains.- Specified by:
getFlavors
in interfaceResult
- Returns:
- the
ResultFlavor
of this Result.
-