org.ldaptive.beans.AttributeValueMutator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ldaptive-beans Show documentation

Mapping, persistence, and code generation API for reading and writing POJOs to an LDAP directory

The newest version!

/* See LICENSE for licensing and NOTICE for copyright. */
package org.ldaptive.beans;

import java.util.Collection;

/**
 * Interface for mutating an attribute value on an arbitrary object.
 *
 * @author  Middleware Services
 */
public interface AttributeValueMutator
{


  /**
   * Returns the name of the attribute.
   *
   * @return  attribute name
   */
  String getName();


  /**
   * Returns whether the attribute is binary.
   *
   * @return  whether the attribute is binary
   */
  boolean isBinary();


  /**
   * Returns the string values of the attribute.
   *
   * @param  object  containing attribute values
   *
   * @return  attribute values
   */
  Collection getStringValues(Object object);


  /**
   * Returns the binary values of the attribute.
   *
   * @param  object  containing attribute values
   *
   * @return  attribute values
   */
  Collection getBinaryValues(Object object);


  /**
   * Sets the string values of the attribute.
   *
   * @param  object  to set values on
   * @param  values  to set
   */
  void setStringValues(Object object, Collection values);


  /**
   * Sets the binary values of the attribute.
   *
   * @param  object  to set values on
   * @param  values  to set
   */
  void setBinaryValues(Object object, Collection values);
}