org.eclipse.osbp.runtime.tests/src/org/eclipse/osbp/runtime/tests/Foo.java

/**
 *                                                                            
 *  Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany) 
 *                                                                            
 *  All rights reserved. This program and the accompanying materials           
 *  are made available under the terms of the Eclipse Public License 2.0        
 *  which accompanies this distribution, and is available at                  
 *  https://www.eclipse.org/legal/epl-2.0/                                 
 *                                 
 *  SPDX-License-Identifier: EPL-2.0                                 
 *                                                                            
 *  Contributors:                                                      
 * 	   Christophe Loetz (Loetz GmbH&Co.KG) - initial implementation
 * 
 */
 package org.eclipse.osbp.runtime.tests;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;

@SuppressWarnings("serial")
public class Foo implements Serializable {
	private PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(
			this);

	private boolean disposed;

	private String name;

	private List<Bar> mybars;

	/**
	 * Returns true, if the object is disposed. Disposed means, that it is
	 * prepared for garbage collection and may not be used anymore. Accessing
	 * objects that are already disposed will cause runtime exceptions.
	 */
	public boolean isDisposed() {
		return this.disposed;
	}

	/**
	 * @see PropertyChangeSupport#addPropertyChangeListener(PropertyChangeListener)
	 */
	public void addPropertyChangeListener(final PropertyChangeListener listener) {
		propertyChangeSupport.addPropertyChangeListener(listener);
	}

	/**
	 * @see PropertyChangeSupport#addPropertyChangeListener(String,
	 *      PropertyChangeListener)
	 */
	public void addPropertyChangeListener(final String propertyName,
			final PropertyChangeListener listener) {
		propertyChangeSupport.addPropertyChangeListener(propertyName, listener);
	}

	/**
	 * @see PropertyChangeSupport#removePropertyChangeListener(PropertyChangeListener)
	 */
	public void removePropertyChangeListener(
			final PropertyChangeListener listener) {
		propertyChangeSupport.removePropertyChangeListener(listener);
	}

	/**
	 * @see PropertyChangeSupport#removePropertyChangeListener(String,
	 *      PropertyChangeListener)
	 */
	public void removePropertyChangeListener(final String propertyName,
			final PropertyChangeListener listener) {
		propertyChangeSupport.removePropertyChangeListener(propertyName,
				listener);
	}

	/**
	 * @see PropertyChangeSupport#firePropertyChange(String, Object, Object)
	 */
	public void firePropertyChange(final String propertyName,
			final Object oldValue, final Object newValue) {
		propertyChangeSupport.firePropertyChange(propertyName, oldValue,
				newValue);
	}

	/**
	 * Checks whether the object is disposed.
	 * 
	 * @throws RuntimeException
	 *             if the object is disposed.
	 */
	private void checkDisposed() {
		if (isDisposed()) {
			throw new RuntimeException("Object already disposed: " + this);
		}
	}

	/**
	 * Calling dispose will destroy that instance. The internal state will be
	 * set to 'disposed' and methods of that object must not be used anymore.
	 * Each call will result in runtime exceptions.
	 * If this object keeps composition containments, these will be disposed
	 * too. So the whole composition containment tree will be disposed on
	 * calling this method.
	 */
	public void dispose() {
		if (isDisposed()) {
			return;
		}
		try {
			// Dispose all the composition references.
			if (this.mybars != null) {
				for (Bar bar : this.mybars) {
					bar.dispose();
				}
				this.mybars = null;
			}

		} finally {
			disposed = true;
		}

	}

	/**
	 * Returns the name property or <code>null</code> if not present.
	 */
	public String getName() {
		checkDisposed();
		return this.name;
	}

	/**
	 * Sets the <code>name</code> property to this instance.
	 * 
	 * @param name
	 *            - the property
	 * @throws RuntimeException
	 *             if instance is <code>disposed</code>
	 * 
	 */
	public void setName(final String name) {
		firePropertyChange("name", this.name, this.name = name);
	}

	/**
	 * Returns an unmodifiable list of mybars.
	 */
	public List<Bar> getMybars() {
		checkDisposed();
		return Collections.unmodifiableList(internalGetMybars());
	}

	/**
	 * Returns the list of <code>bar</code>s thereby lazy initializing it. For
	 * internal use only!
	 * 
	 * @return list - the resulting list
	 * 
	 */
	private List<Bar> internalGetMybars() {
		if (this.mybars == null) {
			this.mybars = new java.util.ArrayList<Bar>();
		}
		return this.mybars;
	}

	/**
	 * Adds the given bar to this object.
	 * <p>
	 * Since the reference is a composition reference, the opposite reference
	 * <code>bar#myfoo</code> of the <code>bar</code> will be handled
	 * automatically and no further coding is required to keep them in sync.
	 * <p>
	 * See {@link bar#setMyfoo(bar)}.
	 * 
	 * @param bar
	 *            - the property
	 * @throws RuntimeException
	 *             if instance is <code>disposed</code>
	 * 
	 */
	public void addToMybars(final Bar bar) {
		checkDisposed();
		bar.setMyfoo(this);
	}

	/**
	 * Removes the given bar from this object.
	 * <p>
	 * Since the reference is a cascading reference, the opposite reference
	 * (bar.myfoo) of the bar will be handled automatically and no further
	 * coding is required to keep them in sync. See {@link bar#setMyfoo(bar)}.
	 * 
	 * @param bar
	 *            - the property
	 * @throws RuntimeException
	 *             if instance is <code>disposed</code>
	 * 
	 */
	public void removeFromMybars(final Bar bar) {
		checkDisposed();
		bar.setMyfoo(null);
	}

	/**
	 * For internal use only!
	 */
	public void internalAddToMybars(final Bar bar) {
		internalGetMybars().add(bar);
	}

	/**
	 * For internal use only!
	 */
	public void internalRemoveFromMybars(final Bar bar) {
		internalGetMybars().remove(bar);
	}
}