Skip navigation links

oracle.javatools.db.ora
Class OpaqueFormatSpec

java.lang.Object
oracle.javatools.db.ora.OpaqueFormatSpec

All Implemented Interfaces:

Copyable

public class OpaqueFormatSpec

extends java.lang.Object

implements Copyable

Abstraction of the Oracle opaque_format_spec.

Since:

11.0

Constructor Summary

OpaqueFormatSpec()

OpaqueFormatSpec(java.lang.String spec)

Method Summary

java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(OpaqueFormatSpec copy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(OpaqueFormatSpec target)
java.lang.String	getSpec()
void	setSpec(java.lang.String spec)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpaqueFormatSpec

public OpaqueFormatSpec()

OpaqueFormatSpec

public OpaqueFormatSpec(java.lang.String spec)

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

setSpec

public void setSpec(java.lang.String spec)

getSpec

public java.lang.String getSpec()

copyToImpl

protected void copyToImpl(OpaqueFormatSpec copy)

equalsImpl

protected boolean equalsImpl(OpaqueFormatSpec target)

Skip navigation links