001package ezvcard.io.text;
002
003import ezvcard.VCardVersion;
004
005/*
006 Copyright (c) 2012-2023, Michael Angstadt
007 All rights reserved.
008
009 Redistribution and use in source and binary forms, with or without
010 modification, are permitted provided that the following conditions are met: 
011
012 1. Redistributions of source code must retain the above copyright notice, this
013 list of conditions and the following disclaimer. 
014 2. Redistributions in binary form must reproduce the above copyright notice,
015 this list of conditions and the following disclaimer in the documentation
016 and/or other materials provided with the distribution. 
017
018 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
019 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
020 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
025 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028 */
029
030/**
031 * Used to pass information about the vCard being written to the property
032 * scribes.
033 * @author Michael Angstadt
034 */
035public class WriteContext {
036        private final VCardVersion version;
037        private final TargetApplication targetApplication;
038        private final boolean includeTrailingSemicolons;
039
040        /**
041         * @param version the version that the vCard should adhere to
042         * @param targetApplication the application that the vCard is being targeted
043         * for or null not to target any specific application
044         * @param includeTrailingSemicolons true to include trailing semicolon
045         * delimiters for structured property values whose list of values end with
046         * null or empty values, false not to
047         */
048        public WriteContext(VCardVersion version, TargetApplication targetApplication, boolean includeTrailingSemicolons) {
049                this.version = version;
050                this.targetApplication = targetApplication;
051                this.includeTrailingSemicolons = includeTrailingSemicolons;
052        }
053
054        /**
055         * Gets the version that the vCard should adhere to.
056         * @return the vCard version
057         */
058        public VCardVersion getVersion() {
059                return version;
060        }
061
062        /**
063         * Gets the application that the vCard is being targeted for.
064         * @return the target application or null not to target any specific
065         * application
066         */
067        public TargetApplication getTargetApplication() {
068                return targetApplication;
069        }
070
071        /**
072         * Gets whether to include trailing semicolon delimiters for structured
073         * property values whose list of values end with null or empty values.
074         * @return true to include the trailing semicolons, false not to
075         */
076        public boolean isIncludeTrailingSemicolons() {
077                return includeTrailingSemicolons;
078        }
079}