javax.sound.sampled

Class Port.Info

Enclosing Class:
Port

public class Port.Info
extends Line.Info

This describes a single port.
Since:
1.3

Field Summary

static Port.Info
COMPACT_DISC
A CD player.
static Port.Info
HEADPHONE
Headphones.
static Port.Info
LINE_IN
Generic input line.
static Port.Info
LINE_OUT
Generic output line.
static Port.Info
MICROPHONE
A microphone.
static Port.Info
SPEAKER
A speaker.

Constructor Summary

Info(Class klass, String name, boolean isSource)
Create a new Info object, given the line's class, the name, and an argument indicating whether this is an input or an output.

Method Summary

boolean
equals(Object o)
Determine whether this Object is semantically equal to another Object.
String
getName()
Return the name of this object.
int
hashCode()
Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean
isSource()
Return true if this describes an input line.
boolean
matches(Line.Info other)
Return true if this Info object matches the given object.
String
toString()
Return a description of this Info object.

Methods inherited from class javax.sound.sampled.Line.Info

getLineClass, matches, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPACT_DISC

public static final Port.Info COMPACT_DISC
A CD player.

HEADPHONE

public static final Port.Info HEADPHONE
Headphones.

LINE_IN

public static final Port.Info LINE_IN
Generic input line.

LINE_OUT

public static final Port.Info LINE_OUT
Generic output line.

MICROPHONE

public static final Port.Info MICROPHONE
A microphone.

SPEAKER

public static final Port.Info SPEAKER
A speaker.

Constructor Details

Info

public Info(Class klass,
            String name,
            boolean isSource)
Create a new Info object, given the line's class, the name, and an argument indicating whether this is an input or an output.
Parameters:
klass - the class of the line
name - the name of the line
isSource - true if this is an input source

Method Details

equals

public final boolean equals(Object o)
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 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 interface Object
Parameters:
Returns:
whether this Object is semantically equal to another

getName

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

hashCode

public final int hashCode()
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 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 interface Object
Returns:
the hash code for this Object

isSource

public boolean isSource()
Return true if this describes an input line.

matches

public boolean matches(Line.Info other)
Return true if this Info object matches the given object.
Overrides:
matches in interface Line.Info
Parameters:
other - the object to match
Returns:
true if they match, false otherwise

toString

public final String toString()
Return a description of this Info object.
Overrides:
toString in interface Line.Info

Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.