net.fortuna.ical4j.vcard.property.Sound Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bw-ical4j-vcard Show documentation
A fork of ical4j-vcard with customizations for bedework
The newest version!
/**
 * Copyright (c) 2012, Ben Fortuna
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  o Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 *  o Neither the name of Ben Fortuna nor the names of any other contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.fortuna.ical4j.vcard.property;

import net.fortuna.ical4j.util.CompatibilityHints;
import net.fortuna.ical4j.util.Strings;
import net.fortuna.ical4j.validate.ValidationException;
import net.fortuna.ical4j.vcard.Group;
import net.fortuna.ical4j.vcard.Parameter;
import net.fortuna.ical4j.vcard.Property;
import net.fortuna.ical4j.vcard.PropertyFactory;
import net.fortuna.ical4j.vcard.parameter.Encoding;
import net.fortuna.ical4j.vcard.parameter.Type;
import net.fortuna.ical4j.vcard.parameter.Value;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.net.URI;
import java.net.URISyntaxException;
import java.text.ParseException;
import java.util.Base64;
import java.util.List;

/**
 * SOUND property.
 * 
 * $Id$
 *
 * Created on 21/10/2008
 *
 * @author Ben
 *
 */
public final class Sound extends Property {

    public static final PropertyFactory FACTORY = new Factory();
    
    private static final long serialVersionUID = -3293436282728289163L;

    private URI uri;

    private byte[] binary;

    private final Log log = LogFactory.getLog(Sound.class);
    
    /**
     * @param uri a URI specifying a sound location
     */
    public Sound(URI uri) {
        super(Id.SOUND);
        this.uri = uri;
        getParameters().add(Value.URI);
    }
    
    /**
     * @param binary a byte array of sound data
     */
    public Sound(byte[] binary) {
        this(binary, null);
    }
    
    /**
     * @param binary a byte array of sound data
     * @param contentType the MIME type of the sound data
     */
    public Sound(byte[] binary, Type contentType) {
        super(Id.SOUND);
        this.binary = binary;
        getParameters().add(Encoding.B);
        if (contentType != null) {
            getParameters().add(contentType);
        }
    }

    /**
     * Factory constructor.
     * @param params property parameters
     * @param value string representation of a property value
     * @throws URISyntaxException where the specified string is not a valid URI
     * @throws IllegalArgumentException where the specified data string cannot be decoded
     */
    public Sound(List params, String value) throws URISyntaxException {
        super(Id.SOUND, params);
        final Parameter valueParameter = getParameter(Parameter.Id.VALUE);
        
        /*
         * in the relaxed parsing mode we allow the vcard 2.1-style VALUE=URL parameter
         */
        if (valueParameter != null && Value.URI.equals(valueParameter) || 
        	valueParameter != null && 
        	     CompatibilityHints.isHintEnabled(CompatibilityHints.KEY_RELAXED_PARSING) && 
        	     "URL".equalsIgnoreCase(valueParameter.getValue())) {
            this.uri = new URI(value);
        }
        else {
            this.binary = Base64.getDecoder().decode(value);
        }
    }
    
    /**
     * @return the uri
     */
    public URI getUri() {
        return uri;
    }

    /**
     * @return the binary
     */
    public byte[] getBinary() {
        return binary;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getValue() {
    	String stringValue = null;
        if (Value.URI.equals(getParameter(Parameter.Id.VALUE))) {
        	stringValue = Strings.valueOf(uri);
        }
        else if (binary != null) {
            try {
                stringValue = Base64.getEncoder().encodeToString(binary);
            }
            catch (IllegalArgumentException ee) {
                log.error("Error encoding binary data", ee);
            }
        }
        return stringValue;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void validate() throws ValidationException {
        for (Parameter param : getParameters()) {
            assertPidParameter(param);
        }
    }

    private static class Factory implements PropertyFactory {

        /**
         * {@inheritDoc}
         */
        public Sound createProperty(final List params, final String value)
                throws URISyntaxException {
            
            return new Sound(params, value);
        }

        /**
         * {@inheritDoc}
         */
        public Sound createProperty(final Group group, final List params, final String value)
                throws URISyntaxException, ParseException {
            // TODO Auto-generated method stub
            return null;
        }
    }
}