org.apache.juneau.serializer.WriterSerializerSession Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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 *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * 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. *
// ***************************************************************************************************************************
package org.apache.juneau.serializer;
import java.io.*;
import org.apache.juneau.*;
/**
* Subclass of {@link SerializerSession} for character-based serializers.
*
* Description
*
* This class is typically the parent class of all character-based serializers.
*
It has 1 abstract method to implement...
*
* -
* {@link #doSerialize(SerializerPipe, Object)}
*
*
*
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused within the same thread.
*/
public abstract class WriterSerializerSession extends SerializerSession {
private final WriterSerializer ctx;
/**
* Create a new session using properties specified in the context.
*
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
* @param args
* Runtime arguments.
* These specify session-level information such as locale and URI context.
* It also include session-level properties that override the properties defined on the bean and
* serializer contexts.
*/
protected WriterSerializerSession(WriterSerializer ctx, SerializerSessionArgs args) {
super(ctx, args);
this.ctx = ctx;
}
/**
* Constructor for sessions that don't require context.
*
* @param args
* Runtime session arguments.
*/
protected WriterSerializerSession(SerializerSessionArgs args) {
this(WriterSerializer.DEFAULT, args);
}
@Override /* SerializerSession */
public final boolean isWriterSerializer() {
return true;
}
/**
* Convenience method for serializing an object to a String.
*
* @param o The object to serialize.
* @return The output serialized to a string.
* @throws SerializeException If a problem occurred trying to convert the output.
*/
@Override /* SerializerSession */
public final String serialize(Object o) throws SerializeException {
StringWriter w = new StringWriter();
serialize(o, w);
return w.toString();
}
@Override /* SerializerSession */
public final String serializeToString(Object o) throws SerializeException {
return serialize(o);
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Configuration property: Maximum indentation.
*
* @see WriterSerializer#WSERIALIZER_maxIndent
* @return
* The maximum indentation level in the serialized document.
*/
public final int getMaxIndent() {
return ctx.getMaxIndent();
}
/**
* Configuration property: Quote character.
*
* @see WriterSerializer#WSERIALIZER_quoteChar
* @return
* The character used for quoting attributes and values.
*/
public final char getQuoteChar() {
return ctx.getQuoteChar();
}
@Override /* Session */
public ObjectMap asMap() {
return super.asMap()
.append("WriterSerializerSession", new ObjectMap()
);
}
}