001/*
002 *   Copyright (C) 2005 Christian Schulte <cs@schulte.it>
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 5091 2016-04-04 15:40:17Z schulte $
029 *
030 */
031package org.jomc.util.test.support;
032
033import org.jomc.util.LineEditor;
034
035/**
036 * {@code LineEditor} removing all input.
037 *
038 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
039 * @version $JOMC: NullEditor.java 5091 2016-04-04 15:40:17Z schulte $
040 *
041 * @see #edit(java.lang.String)
042 */
043public final class NullEditor extends LineEditor
044{
045
046    /**
047     * Creates a new {@code NullEditor} instance.
048     */
049    public NullEditor()
050    {
051        this( null, null );
052    }
053
054    /**
055     * Creates a new {@code NullEditor} instance taking a string to use for separating lines.
056     *
057     * @param lineSeparator String to use for separating lines.
058     */
059    public NullEditor( final String lineSeparator )
060    {
061        this( null, lineSeparator );
062    }
063
064    /**
065     * Creates a new {@code NullEditor} instance taking an editor to chain.
066     *
067     * @param editor The editor to chain.
068     */
069    public NullEditor( final LineEditor editor )
070    {
071        this( editor, null );
072    }
073
074    /**
075     * Creates a new {@code NullEditor} instance taking an editor to chain and a string to use for separating lines.
076     *
077     * @param editor The editor to chain.
078     * @param lineSeparator String to use for separating lines.
079     */
080    public NullEditor( final LineEditor editor, final String lineSeparator )
081    {
082        super( editor, lineSeparator );
083    }
084
085    /**
086     * {@inheritDoc}
087     *
088     * @return This method returns {@code null}.
089     */
090    @Override
091    protected String editLine( final String line )
092    {
093        return null;
094    }
095
096}