org.cryptacular.x509.dn.Attributes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cryptacular Show documentation

The spectacular complement to the Bouncy Castle crypto API for Java.

There is a newer version: 1.2.7

/* See LICENSE for licensing and NOTICE for copyright. */
package org.cryptacular.x509.dn;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
 * Ordered list of {@link Attribute}s.
 *
 * @author  Middleware Services
 */
public class Attributes implements Iterable
{

  /** Underlying attributes. */
  private final List attributes = new ArrayList<>(5);


  /**
   * Adds an attribute by type and value to the end of the attribute list.
   *
   * @param  typeOid  OID of attribute type.
   * @param  value  Attribute value.
   */
  public void add(final String typeOid, final String value)
  {
    final StandardAttributeType type = StandardAttributeType.fromOid(typeOid);
    if (type != null) {
      add(new Attribute(type, value));
    } else {
      add(new Attribute(new UnknownAttributeType(typeOid), value));
    }
  }


  /**
   * Adds the given attribute to the end of the attribute list.
   *
   * @param  attr  Non-null attribute.
   */
  public void add(final Attribute attr)
  {
    if (attr == null) {
      throw new IllegalArgumentException("Attribute cannot be null");
    }
    attributes.add(attr);
  }


  /**
   * Gets the number of attributes contained in this instance.
   *
   * @return  Number of attributes.
   */
  public int size()
  {
    return attributes.size();
  }


  /**
   * Gets an immutable list of attributes.
   *
   * @return  Non-null immutable attribute list.
   */
  public List getAll()
  {
    return Collections.unmodifiableList(attributes);
  }


  /**
   * Gets an immutable list of all attributes of the given type. The order of the returned list reflects the ordering of
   * the underlying attributes.
   *
   * @param  type  Attribute type.
   *
   * @return  Non-null list of attributes of given type. An empty list is returned if there are no attributes of the
   *          given type.
   */
  public List getValues(final AttributeType type)
  {
    final List values = new ArrayList<>(attributes.size());
    for (Attribute attr : attributes) {
      if (attr.getType().equals(type)) {
        values.add(attr.getValue());
      }
    }
    return Collections.unmodifiableList(values);
  }


  /**
   * Gets the first value of the given type that appears in the attribute list.
   *
   * @param  type  Attribute type.
   *
   * @return  Value of first attribute of given type or null if no attributes of given type exist.
   */
  public String getValue(final AttributeType type)
  {
    for (Attribute attr : attributes) {
      if (attr.getType().equals(type)) {
        return attr.getValue();
      }
    }
    return null;
  }


  @Override
  public Iterator iterator()
  {
    return attributes.iterator();
  }
}