Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.sound.sampled
Class AudioFormat.Encoding  view AudioFormat.Encoding download AudioFormat.Encoding.java

java.lang.Object
  extended byjavax.sound.sampled.AudioFormat.Encoding
Enclosing class:
AudioFormat

public static class AudioFormat.Encoding
extends java.lang.Object

This describes a given audio format encoding.

Since:
1.3

Field Summary
static AudioFormat.Encoding ALAW
          The ALAW encoding.
private  java.lang.String name
           
static AudioFormat.Encoding PCM_SIGNED
          The signed PCM encoding.
static AudioFormat.Encoding PCM_UNSIGNED
          The unsigned PCM encoding.
static AudioFormat.Encoding ULAW
          The ULAW encoding.
 
Constructor Summary
AudioFormat.Encoding(java.lang.String name)
          Create a new encoding descriptor, given its name.
 
Method Summary
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 java.lang.String toString()
          Return the name of this encoding.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ALAW

public static final AudioFormat.Encoding ALAW
The ALAW encoding.


PCM_SIGNED

public static final AudioFormat.Encoding PCM_SIGNED
The signed PCM encoding.


PCM_UNSIGNED

public static final AudioFormat.Encoding PCM_UNSIGNED
The unsigned PCM encoding.


ULAW

public static final AudioFormat.Encoding ULAW
The ULAW encoding.


name

private java.lang.String name
Constructor Detail

AudioFormat.Encoding

public AudioFormat.Encoding(java.lang.String name)
Create a new encoding descriptor, given its name.

Method Detail

equals

public final boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


hashCode

public final int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


toString

public final java.lang.String toString()
Return the name of this encoding.