001package biweekly.io.scribe.property;
002
003import java.util.List;
004
005import biweekly.ICalDataType;
006import biweekly.Warning;
007import biweekly.io.json.JCalValue;
008import biweekly.io.xml.XCalElement;
009import biweekly.parameter.ICalParameters;
010import biweekly.property.ListProperty;
011
012/*
013 Copyright (c) 2013, 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 contain a list of values.
039 * @param <T> the property class
040 * @param <V> the value class
041 * @author Michael Angstadt
042 */
043public abstract class ListPropertyScribe<T extends ListProperty<V>, V> extends ICalPropertyScribe<T> {
044        public ListPropertyScribe(Class<T> clazz, String propertyName) {
045                this(clazz, propertyName, ICalDataType.TEXT);
046        }
047
048        public ListPropertyScribe(Class<T> clazz, String propertyName, ICalDataType dataType) {
049                super(clazz, propertyName, dataType);
050        }
051
052        @Override
053        protected String _writeText(final T property) {
054                return list(property.getValues(), new ListCallback<V>() {
055                        public String asString(V value) {
056                                return writeValue(property, value);
057                        }
058                });
059        }
060
061        @Override
062        protected T _parseText(String value, ICalDataType dataType, ICalParameters parameters, List<Warning> warnings) {
063                return parse(list(value), dataType, parameters, warnings);
064        }
065
066        @Override
067        protected void _writeXml(T property, XCalElement element) {
068                for (V value : property.getValues()) {
069                        String valueStr = writeValue(property, value);
070                        element.append(dataType(property), valueStr);
071                }
072        }
073
074        @Override
075        protected T _parseXml(XCalElement element, ICalParameters parameters, List<Warning> warnings) {
076                List<String> values = element.all(defaultDataType);
077                if (!values.isEmpty()) {
078                        return parse(values, defaultDataType, parameters, warnings);
079                }
080
081                throw missingXmlElements(defaultDataType);
082        }
083
084        @Override
085        protected JCalValue _writeJson(T property) {
086                List<V> values = property.getValues();
087                if (!values.isEmpty()) {
088                        return JCalValue.multi(property.getValues());
089                }
090
091                return JCalValue.single("");
092        }
093
094        @Override
095        protected T _parseJson(JCalValue value, ICalDataType dataType, ICalParameters parameters, List<Warning> warnings) {
096                return parse(value.asMulti(), dataType, parameters, warnings);
097        }
098
099        private T parse(List<String> valueStrs, ICalDataType dataType, ICalParameters parameters, List<Warning> warnings) {
100                T property = newInstance(dataType, parameters);
101
102                for (String valueStr : valueStrs) {
103                        V value = readValue(valueStr, dataType, parameters, warnings);
104                        property.addValue(value);
105                }
106
107                return property;
108        }
109
110        protected abstract T newInstance(ICalDataType dataType, ICalParameters parameters);
111
112        protected abstract String writeValue(T property, V value);
113
114        protected abstract V readValue(String value, ICalDataType dataType, ICalParameters parameters, List<Warning> warnings);
115}