Top Description Fields Constructors Methods
javazoom.jl.decoder

public Class OutputChannels

extends Object
Class Inheritance

A Type-safe representation of the the supported output channel constants. This class is immutable and, hence, is thread safe.
Author
Mat McGowan 12/12/99
Since
0.0.7

Field Summary

Modifier and TypeField and Description
public static final OutputChannels
public static final int
BOTH_CHANNELS

Flag to indicate output should include both channels.

public static final OutputChannels
public static final int
DOWNMIX_CHANNELS

Flag to indicate output is mono.

public static final OutputChannels
public static final int
LEFT_CHANNEL

Flag to indicate output should include the left channel only.

private int
public static final OutputChannels
public static final int
RIGHT_CHANNEL

Flag to indicate output should include the right channel only.

Constructor Summary

AccessConstructor and Description
private
OutputChannels(int channels)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static OutputChannels
fromInt(int
one of the OutputChannels channel code constants.
code
)

Creates an OutputChannels instance corresponding to the given channel code.

public int

Returns:

The number of output channels for this channel output type. This will be 2 for BOTH_CHANNELS only, and 1 for all other types.
getChannelCount
()

Retrieves the number of output channels represented by this channel output type.

public int

Returns:

the channel code represented by this instance.
getChannelsOutputCode
()

Retrieves the code representing the desired output channels.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

BOTHback to summary
public static final OutputChannels BOTH
BOTH_CHANNELSback to summary
public static final int BOTH_CHANNELS

Flag to indicate output should include both channels.

DOWNMIXback to summary
public static final OutputChannels DOWNMIX
DOWNMIX_CHANNELSback to summary
public static final int DOWNMIX_CHANNELS

Flag to indicate output is mono.

LEFTback to summary
public static final OutputChannels LEFT
LEFT_CHANNELback to summary
public static final int LEFT_CHANNEL

Flag to indicate output should include the left channel only.

outputChannelsback to summary
private int outputChannels
RIGHT_CHANNELback to summary
public static final int RIGHT_CHANNEL

Flag to indicate output should include the right channel only.

Constructor Detail

OutputChannelsback to summary
private OutputChannels(int channels)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

fromIntback to summary
public static OutputChannels fromInt(int code)

Creates an OutputChannels instance corresponding to the given channel code.

Parameters
code:int

one of the OutputChannels channel code constants.

Exceptions
IllegalArgumentException:
if code is not a valid channel code.
getChannelCountback to summary
public int getChannelCount()

Retrieves the number of output channels represented by this channel output type.

Returns:int

The number of output channels for this channel output type. This will be 2 for BOTH_CHANNELS only, and 1 for all other types.

getChannelsOutputCodeback to summary
public int getChannelsOutputCode()

Retrieves the code representing the desired output channels. Will be one of LEFT_CHANNEL, RIGHT_CHANNEL, BOTH_CHANNELS or DOWNMIX_CHANNELS.

Returns:int

the channel code represented by this instance.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object