001package biweekly.io.scribe.property;
002
003import biweekly.ICalDataType;
004import biweekly.ICalVersion;
005import biweekly.io.ParseContext;
006import biweekly.io.WriteContext;
007import biweekly.io.json.JCalValue;
008import biweekly.io.xml.XCalElement;
009import biweekly.parameter.ICalParameters;
010import biweekly.property.TextProperty;
011
012/*
013 Copyright (c) 2013-2015, Michael Angstadt
014 All rights reserved.
015
016 Redistribution and use in source and binary forms, with or without
017 modification, are permitted provided that the following conditions are met: 
018
019 1. Redistributions of source code must retain the above copyright notice, this
020 list of conditions and the following disclaimer. 
021 2. Redistributions in binary form must reproduce the above copyright notice,
022 this list of conditions and the following disclaimer in the documentation
023 and/or other materials provided with the distribution. 
024
025 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
026 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
027 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
028 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
029 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
030 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
031 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
032 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
033 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
034 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
035 */
036
037/**
038 * Marshals properties that have text values.
039 * @param <T> the property class
040 * @author Michael Angstadt
041 */
042public abstract class TextPropertyScribe<T extends TextProperty> extends ICalPropertyScribe<T> {
043        public TextPropertyScribe(Class<T> clazz, String propertyName) {
044                this(clazz, propertyName, ICalDataType.TEXT);
045        }
046
047        public TextPropertyScribe(Class<T> clazz, String propertyName, ICalDataType dataType) {
048                super(clazz, propertyName, dataType);
049        }
050
051        @Override
052        protected String _writeText(T property, WriteContext context) {
053                String value = property.getValue();
054                if (value != null) {
055                        return escape(value);
056                }
057
058                return "";
059        }
060
061        @Override
062        protected T _parseText(String value, ICalDataType dataType, ICalParameters parameters, ParseContext context) {
063                value = unescape(value);
064                return newInstance(value, context.getVersion());
065        }
066
067        @Override
068        protected void _writeXml(T property, XCalElement element, WriteContext context) {
069                element.append(dataType(property, context.getVersion()), property.getValue());
070        }
071
072        @Override
073        protected T _parseXml(XCalElement element, ICalParameters parameters, ParseContext context) {
074                ICalDataType dataType = defaultDataType(context.getVersion());
075                String value = element.first(dataType);
076                if (value != null) {
077                        return newInstance(value, context.getVersion());
078                }
079
080                throw missingXmlElements(dataType);
081        }
082
083        @Override
084        protected JCalValue _writeJson(T property, WriteContext context) {
085                return JCalValue.single(property.getValue());
086        }
087
088        @Override
089        protected T _parseJson(JCalValue value, ICalDataType dataType, ICalParameters parameters, ParseContext context) {
090                return newInstance(value.asSingle(), context.getVersion());
091        }
092
093        protected abstract T newInstance(String value, ICalVersion version);
094}