14fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/* 24fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Licensed to the Apache Software Foundation (ASF) under one or more 34fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * contributor license agreements. See the NOTICE file distributed with 44fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * this work for additional information regarding copyright ownership. 54fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * The ASF licenses this file to You under the Apache License, Version 2.0 64fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * (the "License"); you may not use this file except in compliance with 74fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * the License. You may obtain a copy of the License at 84fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 94fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * http://www.apache.org/licenses/LICENSE-2.0 104fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 114fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Unless required by applicable law or agreed to in writing, software 124fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * distributed under the License is distributed on an "AS IS" BASIS, 134fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 144fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * See the License for the specific language governing permissions and 154fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * limitations under the License. 164fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 174fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypackage org.apache.commons.io.output; 184fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 194fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.FilterWriter; 204fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.IOException; 214fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.Writer; 224fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 234fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/** 244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * A Proxy stream which acts as expected, that is it passes the method 254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * calls on to the proxied stream and doesn't change which methods are 264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * being called. It is an alternative base class to FilterWriter 274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * to increase reusability, because FilterWriter changes the 284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * methods being called, such as write(char[]) to write(char[], int, int) 294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * and write(String) to write(String, int, int). 304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 314fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @author Stephen Colebourne 324fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @version $Id: ProxyWriter.java 610010 2008-01-08 14:50:59Z niallp $ 334fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 344fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypublic class ProxyWriter extends FilterWriter { 354fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 364fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 374fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Constructs a new ProxyWriter. 384fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param proxy the Writer to delegate to 404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public ProxyWriter(Writer proxy) { 424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy super(proxy); 434fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy // the proxy is stored in a protected superclass variable named 'out' 444fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 454fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 464fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 474fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>write(int)</code> method. 484fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param idx the character to write 494fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(int idx) throws IOException { 524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.write(idx); 534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 554fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 564fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>write(char[])</code> method. 574fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param chr the characters to write 584fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 594fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 604fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(char[] chr) throws IOException { 614fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.write(chr); 624fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 634fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 644fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 654fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>write(char[], int, int)</code> method. 664fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param chr the characters to write 674fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param st The start offset 684fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param end The number of characters to write 694fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 704fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 714fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(char[] chr, int st, int end) throws IOException { 724fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.write(chr, st, end); 734fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 744fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 754fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 764fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>write(String)</code> method. 774fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param str the string to write 784fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 794fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 804fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(String str) throws IOException { 814fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.write(str); 824fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 834fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 844fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 854fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>write(String)</code> method. 864fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param str the string to write 874fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param st The start offset 884fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param end The number of characters to write 894fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 904fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 914fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void write(String str, int st, int end) throws IOException { 924fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.write(str, st, end); 934fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 944fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 954fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 964fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>flush()</code> method. 974fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 984fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 994fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void flush() throws IOException { 1004fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.flush(); 1014fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1024fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1034fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 1044fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Invokes the delegate's <code>close()</code> method. 1054fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @throws IOException if an I/O error occurs 1064fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 1074fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public void close() throws IOException { 1084fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy out.close(); 1094fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 1104fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 1114fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy} 112