javax.sound.sampled
Class ReverbType

java.lang.Object
  extended by javax.sound.sampled.ReverbType

public class ReverbType
extends Object

This represents a reverb effect which can be applied to an audio signal.

Since:
1.3

Constructor Summary
protected ReverbType(String name, int earlyDelay, float earlyInten, int lateDelay, float lateInten, int decay)
          Create a new ReverbType given its attributes.
 
Method Summary
 boolean equals(Object o)
          Determine whether this Object is semantically equal to another Object.
 int getDecayTime()
          Return the decay time.
 int getEarlyReflectionDelay()
          Return the early reflection delay.
 float getEarlyReflectionIntensity()
          Return the early reflection intensity.
 int getLateReflectionDelay()
          Return the late reflection delay.
 float getLateReflectionIntensity()
          Return the late reflection intensity.
 String getName()
          Return the name of this ReverbType.
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 String toString()
          Return a description of this ReverbType.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReverbType

protected ReverbType(String name,
                     int earlyDelay,
                     float earlyInten,
                     int lateDelay,
                     float lateInten,
                     int decay)
Create a new ReverbType given its attributes.

Parameters:
name - the name of this type
earlyDelay - the early delay time in microseconds
earlyInten - the early intensity in decibels
lateDelay - the late delay time in microseconds
lateInten - the late intensity in decibels
decay - the decay time in microseconds
Method Detail

equals

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

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

This is typically overridden to throw a 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 NullPointerException.

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

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
o - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

hashCode

public final int hashCode()
Description copied from class: 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:

Notice that since hashCode is used in 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)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

getDecayTime

public final int getDecayTime()
Return the decay time.


getEarlyReflectionDelay

public final int getEarlyReflectionDelay()
Return the early reflection delay.


getEarlyReflectionIntensity

public final float getEarlyReflectionIntensity()
Return the early reflection intensity.


getLateReflectionDelay

public final int getLateReflectionDelay()
Return the late reflection delay.


getLateReflectionIntensity

public final float getLateReflectionIntensity()
Return the late reflection intensity.


getName

public String getName()
Return the name of this ReverbType.

Since:
1.5

toString

public final String toString()
Return a description of this ReverbType.

Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)