oracle.jdeveloper.builder

Class DataList

java.lang.Object

oracle.jdeveloper.builder.DataList

All Implemented Interfaces:

Copyable

public class DataList
extends java.lang.Object
implements Copyable

Constructor Summary

Constructors

Constructor and Description
DataList()
DataList(java.lang.String selected, java.util.List<java.lang.String> list)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(DataList copy) This is a helper method for copyTo(Object) that can also be used by subclasses that implement copyTo(Object).
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(DataList dataList) This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object).
java.util.List<java.lang.String>	getList() Returns the list contents
java.lang.String	getSelectedItem() Gets the selected item
void	setList(java.util.List<java.lang.String> dataList) Sets the list contents
void	setSelectedItem(java.lang.String selectedItem) Sets the selected item in the list

Methods inherited from class java.lang.Object

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

Constructor Detail

DataList

public DataList()

DataList

public DataList(java.lang.String selected,
        java.util.List<java.lang.String> list)

Method Detail

getSelectedItem

public java.lang.String getSelectedItem()

Gets the selected item

Returns:

The selected item as a string

setSelectedItem

public void setSelectedItem(java.lang.String selectedItem)

Sets the selected item in the list

Parameters:

selectedItem - - The selected item as a String

getList

public java.util.List<java.lang.String> getList()

Returns the list contents

Returns:

The contents as a List

setList

public void setList(java.util.List<java.lang.String> dataList)

Sets the list contents

Parameters:

dataList - - The contents of the list

copyTo

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

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:

object - 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.

copyToImpl

protected final void copyToImpl(DataList copy)

This is a helper method for copyTo(Object) that can also be used by subclasses that implement copyTo(Object). It assumes that the argument is not null.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(DataList dataList)

This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object). It assumes that the argument is not null.