org.ow2.bonita.pvm.internal.wire.WireDefinition Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2005, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.ow2.bonita.pvm.internal.wire;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.ow2.bonita.pvm.internal.wire.descriptor.AbstractDescriptor;
import org.ow2.bonita.util.Log;

/**
 * map of {@link Descriptor}s that serve as input for a {@link WireContext}.
 * 
 * @author Tom Baeyens
 * @author Guillaume Porcher (documentation)
 */
public class WireDefinition implements Serializable {

  private static final long serialVersionUID = 1L;
  @SuppressWarnings("unused")
  private static Log log = Log.getLog(WireDefinition.class.getName());

  transient ClassLoader classLoader;
  /** maps object names to {@link Descriptor}s */
  Map descriptors;
  Map, String> descriptorNames;
  boolean useTypes = true;

  /**
   * references all objects that must eagerly initialized.
   * 
   * @see WireContext
   */
  List eagerInitNames;

  public WireDefinition() {
  }

  public void addDescriptor(Descriptor descriptor) {
    if (descriptor != null) {

      String name = descriptor.getName();

      if (useTypes) {
        Class type = descriptor.getType(this);

        if (type != null) {
          if ((name == null) && (descriptor instanceof AbstractDescriptor)) {
            name = type.getName();
            ((AbstractDescriptor) descriptor).setName(type.getName());
          }

          if ((name != null)
              && ((descriptors == null) || (!descriptors.containsKey(name)))) {
            // add all superclasses and interfaces to map to this descriptor
            addDescriptorType(type, descriptor, name);
          }
        }
      }

      if ((name != null) && (!hasDescriptor(name))) {
        putDescriptor(name, descriptor);

        if (descriptor.isEagerInit()) {
          addEagerInitObjectName(name);
        }
      }

    }
  }

  void putDescriptor(String name, Descriptor descriptor) {
    if (descriptors == null) {
      descriptors = new HashMap();
    }
    descriptors.put(name, descriptor);
  }

  void addDescriptorType(Class type, Descriptor descriptor,
      String descriptorName) {
    if (type != null) {
      if (descriptorNames == null) {
        descriptorNames = new HashMap, String>();
      }
      if (!descriptorNames.containsKey(type)) {
        descriptorNames.put(type, descriptorName);
      }
      addDescriptorType(type.getSuperclass(), descriptor, descriptorName);
      Class[] interfaceTypes = type.getInterfaces();
      if (interfaceTypes != null) {
        for (Class interfaceType : interfaceTypes) {
          addDescriptorType(interfaceType, descriptor, descriptorName);
        }
      }
    }
  }

  public String getDescriptorName(Class type) {
    return (descriptorNames != null ? descriptorNames.get(type) : null);
  }

  /**
   * the descriptor with the given name from the WireDefinition or
   * null if the object doesn't have a descriptor.
   */
  public Descriptor getDescriptor(String objectName) {
    if (descriptors == null) {
      return null;
    }
    return descriptors.get(objectName);
  }

  /**
   * @return previous Descriptor associated with the given name, or null if there
   *         was no Descriptor for this name.
   */
  public synchronized Descriptor addDescriptor(String objectName,
      Descriptor descriptor) {
    if (descriptors == null) {
      descriptors = new HashMap();
    }
    return descriptors.put(objectName, descriptor);
  }

  /**
   * @return previous Descriptor associated with the given name, or null if there
   *         was no Descriptor for this name.
   */
  public synchronized Descriptor removeDescriptor(String objectName) {
    if (descriptors != null) {
      return descriptors.remove(objectName);
    }
    return null;
  }

  public boolean hasDescriptor(String objectName) {
    return (descriptors != null) && (descriptors.containsKey(objectName));
  }

  public void addEagerInitObjectName(String eagerInitObjectName) {
    if (eagerInitObjectName != null) {
      if (eagerInitNames == null) {
        eagerInitNames = new ArrayList();
      }
      eagerInitNames.add(eagerInitObjectName);
    }
  }

  public ClassLoader getClassLoader() {
    // if there is a specific classloader specified
    if (classLoader != null) {
      return classLoader;
    }
    // otherwise, use the current environment classloader
    return Thread.currentThread().getContextClassLoader();
  }

  public Map getDescriptors() {
    return descriptors;
  }

  public List getEagerInitNames() {
    return eagerInitNames;
  }

  public void setEagerInitNames(List eagerInitNames) {
    this.eagerInitNames = eagerInitNames;
  }

  public void setDescriptors(Map descriptors) {
    this.descriptors = descriptors;
  }

  public void setClassLoader(ClassLoader classLoader) {
    this.classLoader = classLoader;
  }
}