Developers
Most visited
Recently visited
CameraCharacteristics.Key
public
static
final
class
CameraCharacteristics.Key
extends Object
| java.lang.Object | |
| ↳ | android.hardware.camera2.CameraCharacteristics.Key<T> |
A Key is used to do camera characteristics field lookups with
CameraCharacteristics#get.
For example, to get the stream configuration map:
StreamConfigurationMap map = cameraCharacteristics.get(
CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP);
To enumerate over all possible keys for CameraCharacteristics, see
CameraCharacteristics#getKeys().
Summary
Public constructors | |
|---|---|
Key(String name, Class<T> type)
Construct a new Key with a given name and type. |
|
Public methods | |
|---|---|
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
String
|
getName()
Return a camelCase, period separated name formatted like:
|
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Return this |
Inherited methods | |
|---|---|
Public constructors
Key
public Key (String name, Class<T> type)
Construct a new Key with a given name and type.
Normally, applications should use the existing Key definitions in
CameraCharacteristics, and not need to construct their own Key objects. However,
they may be useful for testing purposes and for defining custom camera
characteristics.
| Parameters | |
|---|---|
name |
String: This value cannot be null. |
type |
Class: This value cannot be null. |
Public methods
equals
public boolean equals (Object o)
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| 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. |
getName
public String getName ()
Return a camelCase, period separated name formatted like:
"root.section[.subsections].name".
Built-in keys exposed by the Android SDK are always prefixed with "android.";
keys that are device/platform-specific are prefixed with "com.".
For example, CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP would
have a name of "android.scaler.streamConfigurationMap"; whereas a device
specific key might look like "com.google.nexus.data.private".
| Returns | |
|---|---|
String |
String representation of the key name
This value cannot be null. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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(Object)method, then calling thehashCodemethod 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(java.lang.Object)method, then calling thehashCodemethod 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |