org.grails.encoder.EncodedAppenderWriterFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 the original author or authors.
 *
 * 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
 *
 *      https://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.grails.encoder;

import java.io.Writer;

/**
 * This interface marks an instance capable of getting a
 * {@link EncodedAppenderWriter} instance that is connected to it with a certain
 * encoder fixed.
 *
 * @author Lari Hotari
 * @since 2.3
 */
public interface EncodedAppenderWriterFactory {

    /**
     * Gets the EncodedAppenderWriter instance that is connected to this
     * instance implementation with a certain encoder fixed.
     *
     * @param encoder
     *            the encoder to use
     * @param encodingStateRegistry
     *            the current EncodingStateRegistry to use
     * @return the java.io.Writer instance
     */
    Writer getWriterForEncoder(Encoder encoder, EncodingStateRegistry encodingStateRegistry);

}