org.apache.derby.impl.services.locks
Class D_Lock

java.lang.Object
  extended byorg.apache.derby.impl.services.locks.D_Lock
All Implemented Interfaces:
Diagnosticable
Direct Known Subclasses:
D_ActiveLock

public class D_Lock
extends java.lang.Object
implements Diagnosticable


Field Summary
protected  Lock lock
           
 
Constructor Summary
D_Lock()
           
 
Method Summary
 void diag_detail(java.util.Properties prop)
          Default implementation of detail diagnostic on the object.
 java.lang.String diag()
          Default implementation of diagnostic on the object.
 void init(java.lang.Object obj)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lock

protected Lock lock
Constructor Detail

D_Lock

public D_Lock()
Method Detail

init

public void init(java.lang.Object obj)
Specified by:
init in interface Diagnosticable

diag

public java.lang.String diag()
                      throws StandardException
Description copied from interface: Diagnosticable
Default implementation of diagnostic on the object.

This routine returns a string with whatever diagnostic information you would like to provide about this associated object passed in the init() call.

This routine should be overriden by a real implementation of the diagnostic information you would like to provide.

Specified by:
diag in interface Diagnosticable
Returns:
A string with diagnostic information about the object.
Throws:
StandardException - Standard exception policy.

diag_detail

public void diag_detail(java.util.Properties prop)
Description copied from interface: Diagnosticable
Default implementation of detail diagnostic on the object.

This interface provides a way for an object to pass back pieces of information as requested by the caller. The information is passed back and forth through the properties argument. It is expected that the caller knows what kind of information to ask for, and correctly handles the situation when the diagnostic object can't provide the information.

As an example assume an object TABLE exists, and that we have created an object D_TABLE that knows how to return the number of pages in the TABLE object. The code to get that information out would looks something like the following:

print_num_pages(Object table) { Properties prop = new Properties(); prop.put(Page.DIAG_NUM_PAGES, ""); DiagnosticUtil.findDiagnostic(table).diag_detail(prop); System.out.println( "number of pages = " + prop.getProperty(Page.DIAG_NUM_PAGES)); }

This routine should be overriden if there is detail diagnostics to be provided by a real implementation.

Specified by:
diag_detail in interface Diagnosticable


Apache Derby V10.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.