microsoft.exchange.webservices.data.property.definition.ByteArrayPropertyDefinition.java Source code

Introduction

Here is the source code for microsoft.exchange.webservices.data.property.definition.ByteArrayPropertyDefinition.java

Source

/*
 * The MIT License
 * Copyright (c) 2012 Microsoft Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package microsoft.exchange.webservices.data.property.definition;

import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
import microsoft.exchange.webservices.data.core.enumeration.property.PropertyDefinitionFlags;
import org.apache.commons.codec.binary.Base64;

import java.util.EnumSet;

/**
 * Represents byte array property definition.
 */
public final class ByteArrayPropertyDefinition extends TypedPropertyDefinition<byte[]> {

    /**
     * Initializes a new instance.
     *
     * @param xmlElementName Name of the XML element.
     * @param uri            The URI.
     * @param flags          The flags.
     * @param version        The version.
     */
    public ByteArrayPropertyDefinition(String xmlElementName, String uri, EnumSet<PropertyDefinitionFlags> flags,
            ExchangeVersion version) {
        super(xmlElementName, uri, flags, version);
    }

    /**
     * Parses the specified value.
     *
     * @param value accepts String
     * @return value
     */
    @Override
    protected byte[] parse(String value) {
        return Base64.decodeBase64(value);
    }

    /**
     * Converts byte array property to a string.
     *
     * @param value accepts Object
     * @return value
     */
    @Override
    protected String toString(byte[] value) {
        return Base64.encodeBase64String(value);
    }

    /**
     * Gets a value indicating whether this property definition is for a
     * nullable type (ref, int?, bool?...).
     *
     * @return True
     */
    @Override
    public boolean isNullable() {
        return true;
    }

    /**
     * Gets the property type.
     */
    @Override
    public Class<Byte> getType() {
        return Byte.class;
    }

}