1 /* 2 * Copyright (C) Christian Schulte, 2005-206 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * o Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * o Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in 14 * the documentation and/or other materials provided with the 15 * distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 19 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * $JOMC: NullEditor.java 4613 2012-09-22 10:07:08Z schulte $ 29 * 30 */ 31 package org.jomc.util.test.support; 32 33 import org.jomc.util.LineEditor; 34 35 /** 36 * {@code LineEditor} removing all input. 37 * 38 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 39 * @version $JOMC: NullEditor.java 4613 2012-09-22 10:07:08Z schulte $ 40 * 41 * @see #edit(java.lang.String) 42 */ 43 public final class NullEditor extends LineEditor 44 { 45 46 /** Creates a new {@code NullEditor} instance. */ 47 public NullEditor() 48 { 49 this( null, null ); 50 } 51 52 /** 53 * Creates a new {@code NullEditor} instance taking a string to use for separating lines. 54 * 55 * @param lineSeparator String to use for separating lines. 56 */ 57 public NullEditor( final String lineSeparator ) 58 { 59 this( null, lineSeparator ); 60 } 61 62 /** 63 * Creates a new {@code NullEditor} instance taking an editor to chain. 64 * 65 * @param editor The editor to chain. 66 */ 67 public NullEditor( final LineEditor editor ) 68 { 69 this( editor, null ); 70 } 71 72 /** 73 * Creates a new {@code NullEditor} instance taking an editor to chain and a string to use for separating lines. 74 * 75 * @param editor The editor to chain. 76 * @param lineSeparator String to use for separating lines. 77 */ 78 public NullEditor( final LineEditor editor, final String lineSeparator ) 79 { 80 super( editor, lineSeparator ); 81 } 82 83 /** 84 * {@inheritDoc} 85 * @return This method returns {@code null}. 86 */ 87 @Override 88 protected String editLine( final String line ) 89 { 90 return null; 91 } 92 93 }