BundleSymbolicName.java

package org.springframework.roo.felix;

import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;

/**
 * Represents a Bundle Symbolic Name.
 * 
 * @author Ben Alex
 * @since 1.0
 */
public class BundleSymbolicName implements Comparable<BundleSymbolicName> {

  private final String key;

  public BundleSymbolicName(final String key) {
    Validate.notBlank(key, "Key required");
    this.key = key;
  }

  public final int compareTo(final BundleSymbolicName o) {
    if (o == null) {
      return -1;
    }
    return key.compareTo(o.key);
  }

  @Override
  public final boolean equals(final Object obj) {
    return obj instanceof BundleSymbolicName && compareTo((BundleSymbolicName) obj) == 0;
  }

  /**
   * Locates the bundle ID for this BundleSymbolicName, if available.
   * 
   * @param context to search (required)
   * @return the ID (or null if cannot be found)
   */
  public Long findBundleIdWithoutFail(final BundleContext context) {
    Validate.notNull(context, "Bundle context is unavailable");
    final Bundle[] bundles = context.getBundles();
    if (bundles == null) {
      throw new IllegalStateException("Bundle IDs cannot be retrieved as BundleContext unavailable");
    }
    for (final Bundle b : bundles) {
      if (getKey().equals(b.getSymbolicName())) {
        return b.getBundleId();
      }
    }
    throw new IllegalStateException("Bundle symbolic name '" + getKey()
        + "' has no local bundle ID at this time");
  }

  /**
   * Locates the Bundle for this BundleSymbolicName, if available
   * 
   * @param context
   * @return
   */
  public Bundle findBundleWithoutFail(final BundleContext context) {
    Validate.notNull(context, "Bundle context is unavailable");
    final Bundle[] bundles = context.getBundles();
    if (bundles == null) {
      throw new IllegalStateException("Bundle cannot be retrieved as BundleContext unavailable");
    }
    for (final Bundle b : bundles) {
      if (getKey().equals(b.getSymbolicName())) {
        return b;
      }
    }
    throw new IllegalStateException("Bundle symbolic name '" + getKey()
        + "' has no local bundle at this time");
  }

  public String getKey() {
    return key;
  }

  @Override
  public final int hashCode() {
    return key.hashCode();
  }

  @Override
  public String toString() {
    final ToStringBuilder builder = new ToStringBuilder(this);
    builder.append("key", key);
    return builder.toString();
  }
}