michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.data;
michael@0: 
michael@0: import java.nio.charset.Charset;
michael@0: 
michael@0: import net.fortuna.ical4j.util.CompatibilityHints;
michael@0: 
michael@0: /**
michael@0:  * Base class for model outputters.
michael@0:  * 
michael@0:  * <pre>
michael@0:  * $Id$
michael@0:  *
michael@0:  * Created on 29/12/2008
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben
michael@0:  *
michael@0:  */
michael@0: public abstract class AbstractOutputter {
michael@0: 
michael@0:     /**
michael@0:      * The default character set used to generate output.
michael@0:      */
michael@0:     protected static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
michael@0: 
michael@0:     private boolean validating;
michael@0: 
michael@0:     /**
michael@0:      * The maximum line length allowed.
michael@0:      */
michael@0:     protected int foldLength;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public AbstractOutputter() {
michael@0:         this(true);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param validating indicates whether to validate calendar when outputting to stream
michael@0:      */
michael@0:     public AbstractOutputter(final boolean validating) {
michael@0:         this(validating, CompatibilityHints.isHintEnabled(CompatibilityHints.KEY_OUTLOOK_COMPATIBILITY)
michael@0:                 ? FoldingWriter.MAX_FOLD_LENGTH
michael@0:                         : FoldingWriter.REDUCED_FOLD_LENGTH);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param validating indicates whether to validate calendar when outputting to stream
michael@0:      * @param foldLength maximum number of characters before a line is folded
michael@0:      */
michael@0:     public AbstractOutputter(final boolean validating, final int foldLength) {
michael@0:         this.validating = validating;
michael@0:         this.foldLength = foldLength;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the validating.
michael@0:      */
michael@0:     public final boolean isValidating() {
michael@0:         return validating;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param validating The validating to set.
michael@0:      */
michael@0:     public final void setValidating(final boolean validating) {
michael@0:         this.validating = validating;
michael@0:     }
michael@0: }