1 /* 2 * Copyright 2001-2004 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package org.apache.axis.components.encoding; 17 18 import java.io.Writer; 19 import java.io.IOException; 20 21 /** 22 * Interface for XMLEncoders 23 */ 24 public interface XMLEncoder { 25 /** 26 * gets the encoding supported by this encoder 27 * @return string 28 */ 29 public String getEncoding(); 30 31 /** 32 * encode a given string 33 * @param xmlString string to be encoded 34 * @return encoded string 35 */ 36 public String encode(String xmlString); 37 38 /** 39 * write the encoded version of a given string 40 * @param writer writer to write this string to 41 * @param xmlString string to be encoded 42 */ 43 public void writeEncoded(Writer writer, String xmlString) 44 throws IOException; 45 } 46