to top
Android APIs
public class

BaseObj

extends Object
java.lang.Object
   ↳ android.renderscript.BaseObj
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

BaseObj is the base class for all RenderScript objects owned by a RS context. It is responsible for lifetime management and resource tracking. This class should not be used by a user application.

Summary

Public Methods
synchronized void destroy()
Frees any native resources associated with this object.
boolean equals(Object obj)
Compare the current BaseObj with another BaseObj for equality.
String getName()
int hashCode()
Calculates the hash code value for a BaseObj.
void setName(String name)
setName assigns a name to an object.
Protected Methods
void finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public synchronized void destroy ()

Added in API level 11

Frees any native resources associated with this object. The primary use is to force immediate cleanup of resources when it is believed the GC will not respond quickly enough.

public boolean equals (Object obj)

Added in API level 11

Compare the current BaseObj with another BaseObj for equality.

Parameters
obj The object to check equality with.
Returns
  • boolean

public String getName ()

Added in API level 14

Returns
  • name of the renderscript object

public int hashCode ()

Added in API level 11

Calculates the hash code value for a BaseObj.

Returns
  • int

public void setName (String name)

Added in API level 11

setName assigns a name to an object. This object can later be looked up by this name.

Parameters
name The name to assign to the object.

Protected Methods

protected void finalize ()

Added in API level 11

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable