com.servicerocket.confluence.randombits.metadata.impl.StandardMetadataStorage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
There is a newer version: 2.5.12
/*
 * Copyright (c) 2006, David Peterson
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of "randombits.org" nor the names of its 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 com.servicerocket.confluence.randombits.metadata.impl;

import com.atlassian.confluence.core.ContentEntityObject;
import com.servicerocket.confluence.randombits.metadata.MetadataManager;
import com.servicerocket.confluence.randombits.metadata.MetadataStorage;
import com.servicerocket.confluence.randombits.metadata.Notifiable;
import com.servicerocket.confluence.randombits.metadata.TypeConversionException;
import com.servicerocket.confluence.randombits.storage.MapStorage;
import org.apache.commons.lang.ObjectUtils;

import java.util.Map;

/**
 * This is the most common instance of metadata storage. It provides access to
 * the standard metadata information.
 */
public class StandardMetadataStorage extends MapStorage implements MetadataStorage {

    private ContentEntityObject content;

    private boolean modified = false;

    private boolean readOnly;

    private final MetadataManager metadataManager;

    /**
     * @param content         The content object.
     * @param base            The Map serving as the base storage location.
     * @param readOnly        If true, the storage will be read-only.
     * @param metadataManager
     */
    StandardMetadataStorage(MetadataManager metadataManager, ContentEntityObject content, Map base, boolean readOnly) {
        super(base);
        this.content = content;
        this.readOnly = readOnly;
        this.metadataManager = metadataManager;
    }

    /**
     * @return the ContentEntityObject the metadata is for.
     */
    public ContentEntityObject getContent() {
        return content;
    }

    /**
     * Returns true if the metadata has been modified since it
     * was last loaded/created.
     *
     * @return true if modified.
     */
    public boolean isModified() {
        return modified;
    }

    @Override
    protected  T toType(Object value, T def, Class clazz) {
        if (value != null) {
            Object original;
            try {
                original = metadataManager.fromStorable(value);
                if (original == null) {
                    //throw new IllegalArgumentException( "Unsupported type: " + value.getClass() );
                    return null;
                }
                value = original;
            } catch (TypeConversionException e) {
                throw new IllegalArgumentException(e.getMessage(), e);
            }
        }

        if (clazz.isInstance(value)) {
            return (T) value;
        }
        return def;
    }

    /**
     * Added support for
     */
    @Override
    protected void setBaseObject(String name, Object value) {
        Object current = getBaseObject(name);
        if (!ObjectUtils.equals(current, value)) {
            // Notify any outgoing objects of their removal.
            if (current instanceof Notifiable) {
                ((Notifiable) current).removalNotification(name);
            }

            try {
                value = metadataManager.toStorable(value);
            } catch (TypeConversionException e) {
                throw new IllegalArgumentException(e.getMessage(), e);
            }
            super.setBaseObject(name, value);

            // Notify the incoming value of it's storage.
            if (value instanceof Notifiable) {
                ((Notifiable) value).storageNotification(name);
            }

            modified = true;
        }
    }

    @Override
    public boolean isReadOnly() {
        if (readOnly) {
            return true;
        }
        return super.isReadOnly();
    }

}