src/org/apache/axis/components/encoding/XMLEncoder.java

/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * 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
 * 
 *      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.axis.components.encoding;

import java.io.Writer;
import java.io.IOException;

/**
 * Interface for XMLEncoders
 */
public interface XMLEncoder {
    /**
     * gets the encoding supported by this encoder
     * @return string
     */
    public String getEncoding();

    /**
     * encode a given string
     * @param xmlString string to be encoded
     * @return encoded string
     */
    public String encode(String xmlString);

    /**
     * write the encoded version of a given string
     * @param writer writer to write this string to
     * @param xmlString string to be encoded
     */
    public void writeEncoded(Writer writer, String xmlString)
            throws IOException;
}