Class Writers.PrimitiveTypeWriter

java.lang.Object

com.cedarsoftware.io.Writers.PrimitiveTypeWriter

All Implemented Interfaces:

JsonWriter.JsonClassWriter

Direct Known Subclasses:

LongWriter, Writers.CharacterWriter, Writers.FloatingPointWriter, Writers.LocalDateAsLong, Writers.PrimitiveBasicStringWriter, Writers.PrimitiveUtf8StringWriter, Writers.PrimitiveValueWriter, Writers.TemporalWriter

Enclosing class:

Writers

public static class Writers.PrimitiveTypeWriter
extends Object
implements JsonWriter.JsonClassWriter

Used as a template to write out types that will have a primitive form. Uses the default key of "value" unless overridden

Author:

John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor	Description
PrimitiveTypeWriter()

Method Summary

Modifier and Type	Method	Description
protected String	getKey()
boolean	hasPrimitiveForm(WriterContext writerContext)
void	write(Object obj, boolean showType, Writer output, WriterContext context)	When write() is called, it is expected that subclasses will write the appropriate JSON to the passed in Writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cedarsoftware.io.JsonWriter.JsonClassWriter

writePrimitiveForm

Constructor Details

PrimitiveTypeWriter

public PrimitiveTypeWriter()

Method Details

getKey

protected String getKey()

write

public void write(Object obj,
 boolean showType,
 Writer output,
 WriterContext context)
           throws IOException

Description copied from interface: JsonWriter.JsonClassWriter

When write() is called, it is expected that subclasses will write the appropriate JSON to the passed in Writer.

Specified by:

write in interface JsonWriter.JsonClassWriter

Parameters:

obj - Object to be written in JSON format.

showType - boolean indicating whether to show @type.

output - Writer destination to where the actual JSON is written.

context - WriterContext to get writeOptions and other write access

Throws:

IOException - if thrown by the writer. Will be caught at a higher level and wrapped in JsonIoException.

hasPrimitiveForm

public boolean hasPrimitiveForm(WriterContext writerContext)

Specified by:

hasPrimitiveForm in interface JsonWriter.JsonClassWriter

Parameters:

writerContext - WriterContext to get writeOptions and other write access

Returns:

boolean true if the class being written has a primitive (non-object) form. Default is false since most custom writers will not have a primitive form.