xapi.util.api.Digester Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xapi-dev Show documentation

Everything needed to run a comprehensive dev environment. Just type X_ and pick a service from autocomplete; new dev modules will be added as they are built. The only dev service not included in the uber jar is xapi-dev-maven, as it includes all runtime dependencies of maven, adding ~4 seconds to build time, and 6 megabytes to the final output jar size (without xapi-dev-maven, it's ~1MB).

The newest version!

/**
 *
 */
package xapi.util.api;

/**
 * A simple interface for creating digests of bytes; this is used primarily so we can have
 * shared code that is able to invoke Digest operations, without accessing any potentially
 * unsupported classes in a given environment.
 * 
 * This also allows the digest function to be easily pluggable, so end users can select the
 * digest algorithm to use.  The default implementation uses java core MD5 hashing.
 * 
 * This interface should be instantiated via X_Inject.instance(Digester.class),
 * as a digester needs to store internal state, it cannot be a singleton.
 *
 * @author James X. Nelson ([email protected], @james)
 *
 */
public interface Digester {

  Digester update(byte[] bytes, int offset, int length);

  byte[] digest();

  byte[] digest(byte[] bytes);

  String toString(byte[] bytes);
}