001    /*
002     *   Copyright (C) Christian Schulte, 2005-206
003     *   All rights reserved.
004     *
005     *   Redistribution and use in source and binary forms, with or without
006     *   modification, are permitted provided that the following conditions
007     *   are met:
008     *
009     *     o Redistributions of source code must retain the above copyright
010     *       notice, this list of conditions and the following disclaimer.
011     *
012     *     o Redistributions in binary form must reproduce the above copyright
013     *       notice, this list of conditions and the following disclaimer in
014     *       the documentation and/or other materials provided with the
015     *       distribution.
016     *
017     *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018     *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019     *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020     *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021     *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022     *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023     *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024     *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025     *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026     *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027     *
028     *   $JOMC: NullEditor.java 3838 2011-10-08 20:15:41Z schulte2005 $
029     *
030     */
031    package org.jomc.util.test.support;
032    
033    import org.jomc.util.LineEditor;
034    
035    /**
036     * {@code LineEditor} removing all input.
037     *
038     * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a>
039     * @version $JOMC: NullEditor.java 3838 2011-10-08 20:15:41Z schulte2005 $
040     *
041     * @see #edit(java.lang.String)
042     */
043    public final class NullEditor extends LineEditor
044    {
045    
046        /** Creates a new {@code NullEditor} instance. */
047        public NullEditor()
048        {
049            this( null, null );
050        }
051    
052        /**
053         * Creates a new {@code NullEditor} instance taking a string to use for separating lines.
054         *
055         * @param lineSeparator String to use for separating lines.
056         */
057        public NullEditor( final String lineSeparator )
058        {
059            this( null, lineSeparator );
060        }
061    
062        /**
063         * Creates a new {@code NullEditor} instance taking an editor to chain.
064         *
065         * @param editor The editor to chain.
066         */
067        public NullEditor( final LineEditor editor )
068        {
069            this( editor, null );
070        }
071    
072        /**
073         * Creates a new {@code NullEditor} instance taking an editor to chain and a string to use for separating lines.
074         *
075         * @param editor The editor to chain.
076         * @param lineSeparator String to use for separating lines.
077         */
078        public NullEditor( final LineEditor editor, final String lineSeparator )
079        {
080            super( editor, lineSeparator );
081        }
082    
083        /**
084         * {@inheritDoc}
085         * @return This method returns {@code null}.
086         */
087        @Override
088        protected String editLine( final String line )
089        {
090            return null;
091        }
092    
093    }