All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.openmdx.base.collection.MarshallingCollection Maven / Gradle / Ivy

Go to download

openMDX/Base Library

There is a newer version: 2.18.10
Show newest version
/*
 * ====================================================================
 * Project:     openMDX, http://www.openmdx.org/
 * Description: Marshalling Collection
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2004-2010, OMEX AG, Switzerland
 * 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 the openMDX team 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.
 * 
 * ------------------
 * 
 * This product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.base.collection;

import java.io.Serializable;
import java.util.AbstractCollection;
import java.util.Collection;
import java.util.Iterator;

import org.openmdx.base.exception.RuntimeServiceException;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.marshalling.ExceptionListenerMarshaller;
import org.openmdx.base.marshalling.Marshaller;
import org.openmdx.base.marshalling.ReluctantUnmarshalling;

/**
 * Marshalling Collection
 */
@SuppressWarnings("unchecked")
public class MarshallingCollection
  extends AbstractCollection 
  implements Serializable
{
    
    /**
     * Constructor
     * 
     * @param marshaller
     * @param collection
     * @param unmarshalling
     */
    public MarshallingCollection(
        Marshaller marshaller,
        Collection collection, 
        Unmarshalling unmarshalling
    ) {
        this.marshaller = marshaller;
        this.delegate = (Collection) collection;
        this.unmarshalling = unmarshalling;
    }

    /**
     * Constructor
     * 
     * @param marshaller
     * @param collection
     */
    public MarshallingCollection(
        Marshaller marshaller,
        Collection collection
    ) {
        this(
            new ExceptionListenerMarshaller(marshaller), 
            collection, 
            marshaller instanceof ReluctantUnmarshalling ? Unmarshalling.RELUCTANT : Unmarshalling.EAGER
        );
    }

    /**
     * Implements Serializable
     */
    private static final long serialVersionUID = 3977579212402079801L;

    /**
     * The delegate collection
     */
    private Collection delegate;

    /**
     * The marshaller
     */    
    protected final Marshaller marshaller;

    /**
     * The unmarshal preference
     */
    protected final Unmarshalling unmarshalling;
    
    /**
     * Retrieve the delegate
     * 

     * This method may be overridden by a sub-class for dynamic delegation.
     * 
     * @return the delegate
     */
    @SuppressWarnings("rawtypes")
    protected Collection getDelegate(){
        return this.delegate;
    }

    /**
     * Replace the delegate for static delegation
     * 
     * @param the new delegate
     */
    @SuppressWarnings("rawtypes")
    protected void setDelegate(
        Collection delegate
    ){
        this.delegate = delegate;
    }
    
    /* (non-Javadoc)
     * @see java.util.AbstractCollection#toString()
     */
    @Override
    public String toString() {
        return this.getDelegate().toString();
    }

        
    //------------------------------------------------------------------------
    // Implements Collection
    //------------------------------------------------------------------------

    /* (non-Javadoc)
     * @see java.util.Collection#clear()
     */
    @Override
    public void clear() {
        getDelegate().clear();
    }

    /* (non-Javadoc)
     * @see java.util.Collection#add(java.lang.Object)
     */
    @Override
    public boolean add(
        E element
    ) {
        try {
            return getDelegate().add(
                marshaller.unmarshal(element)
            );
        }
        catch(ServiceException e) {
            throw new RuntimeServiceException(e);
        }        
    }

    /* (non-Javadoc)
     * @see java.util.Collection#contains(java.lang.Object)
     */
    @Override
    public boolean contains(
        Object element
    ) {
        try {
            switch(this.unmarshalling) {
                case RELUCTANT: 
                    return super.contains(
                        element
                    );
                case EAGER: default: 
                    return getDelegate().contains(
                        marshaller.unmarshal(element)
                    );  
            }
        }
        catch(ServiceException e) {
            throw new RuntimeServiceException(e);
        }        
    }

    /* (non-Javadoc)
     * @see java.util.Collection#isEmpty()
     */
    @Override
    public boolean isEmpty() {
        return getDelegate().isEmpty();
    }
    
    @Override
    public Iterator iterator(
    ) {
        return new MarshallingIterator(
            getDelegate().iterator()
        );
    }

    /* (non-Javadoc)
     * @see java.util.Collection#remove(java.lang.Object)
     */
    @Override
    public boolean remove(
        Object element
    ) {
        try {
            switch(this.unmarshalling) {
                case RELUCTANT: 
                    return super.remove(
                        element
                    );
                case EAGER: default: 
                    return getDelegate().remove(
                        marshaller.unmarshal(element)
                     );
            }
        }
        catch(ServiceException e) {
            throw new RuntimeServiceException(e);
        }        
    }

    @Override
    public int size(
    ) {
        return getDelegate().size();
    }

    
    //------------------------------------------------------------------------
    // Class MarshallingIterator
    //------------------------------------------------------------------------
    
    /**
     * Marshalling Iterator
     * @author hburger
     *
     * To change the template for this generated type comment go to
     * Window>Preferences>Java>Code Generation>Code and Comments
     */
    protected class MarshallingIterator
        implements Iterator 
    {

        /**
         * 
         * @param iterator
         */
        MarshallingIterator(
            Iterator iterator
        ) {
            this.iterator = iterator;
        }

        /*
         *  (non-Javadoc)
         * @see java.util.Iterator#hasNext()
         */        
        public boolean hasNext(
        ) {
            return this.iterator.hasNext();
        }
        
        /**
         * 
         */
        public E next(
        ) {
            try {
                return (E) marshaller.marshal(
                    iterator.next()
                );
            }
            catch(ServiceException e) {
                throw new RuntimeServiceException(e);
            }            
        }

        /**
         * 
         */        
        public void remove(
        ) {
            this.iterator.remove();
        }

        /**
         * 
         */
        private final Iterator iterator;
      
    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy