View Javadoc
1   /**
2    * This file Copyright (c) 2014-2015 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.rendering.util;
35  
36  import java.io.IOException;
37  
38  /**
39   * Wrapper for {@link Appendable} that appends all the text to wrapped Appendable only if writeEnabled=true.
40   */
41  public class FilteringAppendableWrapper implements Appendable {
42  
43      private boolean writeEnabled = true;
44      private Appendable appendable;
45  
46      public boolean isWriteEnabled() {
47          return writeEnabled;
48      }
49  
50      public void setWriteEnabled(boolean writeEnabled) {
51          this.writeEnabled = writeEnabled;
52      }
53  
54      @Override
55      public Appendable append(CharSequence csq) throws IOException {
56          checkAppendableForNull();
57          if (isWriteEnabled()) {
58              getWrappedAppendable().append(csq);
59          }
60          return getWrappedAppendable();
61      }
62  
63      @Override
64      public Appendable append(char c) throws IOException {
65          checkAppendableForNull();
66          if (isWriteEnabled()) {
67              getWrappedAppendable().append(c);
68          }
69          return getWrappedAppendable();
70      }
71  
72      @Override
73      public Appendable append(CharSequence csq, int start, int end) throws IOException {
74          checkAppendableForNull();
75          if (isWriteEnabled()) {
76              getWrappedAppendable().append(csq, start, end);
77          }
78          return getWrappedAppendable();
79      }
80  
81      private void checkAppendableForNull() throws IOException {
82          if (getWrappedAppendable() == null) {
83              throw new IOException("Can't use wrapped appendable since it's not yet initialized.");
84          }
85      }
86  
87      public Appendable getWrappedAppendable() {
88          return appendable;
89      }
90  
91      public void setWrappedAppendable(Appendable appendable) {
92          this.appendable = appendable;
93      }
94  }