Package org.kohsuke.stapler.export
Interface DataWriter
public interface DataWriter
Receives the event callback on the model data to be exposed.
The call sequence is:
EVENTS := type? startObject PROPERTY* endObject PROPERTY := name VALUE VALUE := valuePrimitive | value | valueNull | startArray VALUE* endArray | EVENTS
- Author:
- Kohsuke Kawaguchi
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Recommended property name to write out the 'type' parameter oftype(Type,Class)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
endArray()
void
default ExportConfig
void
void
void
default void
Augments the nextstartObject()
call by specifying the type information of that object.void
void
void
-
Field Details
-
CLASS_PROPERTY_NAME
Recommended property name to write out the 'type' parameter oftype(Type,Class)
- See Also:
-
-
Method Details
-
name
- Throws:
IOException
-
valuePrimitive
- Throws:
IOException
-
value
- Throws:
IOException
-
valueNull
- Throws:
IOException
-
startArray
- Throws:
IOException
-
endArray
- Throws:
IOException
-
type
Augments the nextstartObject()
call by specifying the type information of that object.- Parameters:
expected
- The declared type of the variable that references this object. Null if the object is not referenced by anyone, for example when it's the root.actual
- The actual type of the object being written. Null if the object is synthetic and has no valid Java type- Throws:
IOException
-
startObject
- Throws:
IOException
-
endObject
- Throws:
IOException
-
getExportConfig
-