AssetList

java.lang.Object
- org.qbroker.common.AssetList

Direct Known Subclasses:

CachedList, JSONTemplate
```
public class AssetList
extends java.lang.Object
```
AssetList is a list of assets with the unique keys and IDs. Each asset has a well-defined object (not null) and its MetaData which is an opaque array of longs. It is up to the developer to decide what consists of the MetaData. For example, the gid, ttl or option can be stored in the MetaData for better descriptions of the asset. The range of IDs is from 0 thru capacity - 1.

This class is only a data container. For access efficiency, there is no protection on data integrity. It is NOT MT-Safe either. Therefore, please use it with care.

Author:

yannanlu@yahoo.com

Constructor Summary

Constructors
Constructor and Description

AssetList(java.lang.String name, int capacity)

Constructors
Constructor and Description
`AssetList(java.lang.String name, int capacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`add(java.lang.String key, long[] meta, java.lang.Object obj)` It checks object and the existence of the key first.
`int`	`add(java.lang.String key, long[] meta, java.lang.Object obj, int id)` It checks object and the existence of the key first.
`Browser`	`browser()` returns a Browser for all IDs in the natural order
`void`	`clear()`
`boolean`	`containsKey(java.lang.String key)` returns true if the the list contains the key
`boolean`	`existsID(int id)` returns true if the assset for the id exists
`protected void`	`finalize()`
`java.lang.Object`	`get(int id)` returns the object of the key
`java.lang.Object`	`get(java.lang.String key)` returns the object of the key
`int`	`getCapacity()`
`int`	`getID(java.lang.String key)` returns the id of the object on the key or null if no object on the key
`java.lang.String`	`getKey(int id)` returns the key of the id or null if no object at the id
`long[]`	`getMetaData(int id)` returns the metadata for the object of id
`long[]`	`getMetaData(java.lang.String key)` returns the metadata for the object referenced by the key
`java.lang.String`	`getName()`
`int`	`insert(java.lang.String key, long[] meta, java.lang.Object obj, int id)` It checks the object and the existence of the key first.
`boolean`	`isFull()`
`int`	`queryIDs(int[] ids)` returns number of assets after loading the ids to the buffer in natural order
`java.lang.Object`	`remove(int id)` removes both the object of the id and its metadata.
`java.lang.Object`	`remove(java.lang.String key)` removes both the object of the key and its metadata.
`java.lang.String`	`replaceKey(int id, java.lang.String key)` replaces the key of the id and returns the original key upon success.
`int`	`rotate(int id)` rotates the object with the id and its metadata to the end of the list and returns 1 for success, 0 for failure or -1 for out of bound.
`java.lang.Object`	`set(int id, java.lang.Object obj)` It checks the id first.
`java.lang.Object`	`set(java.lang.String key, java.lang.Object obj)` It checks the object and the existence of the key first.
`int`	`size()`
`int`	`swap(int id, int jd)` swaps two objects and their metadata identified by id and jd and returns 1 for success, 0 for failure or -1 for out of bound.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AssetList
```
public AssetList(java.lang.String name,
                 int capacity)
```
- Method Detail
  - size
```
public int size()
```
  - getName
```
public java.lang.String getName()
```
  - getCapacity
```
public int getCapacity()
```
  - add
```
public int add(java.lang.String key,
               long[] meta,
               java.lang.Object obj)
```
    It checks object and the existence of the key first. If no such key exists, it adds the object and the metadata to the list. It returns the unique ID upon success or -1 otherwise.
  - add
```
public int add(java.lang.String key,
               long[] meta,
               java.lang.Object obj,
               int id)
```
    It checks object and the existence of the key first. If no such key exists, it reserves the id-th cell from the list and adds the object and the metadata to the cell with the index of id. It returns the id upon success or -1 otherwise.
  - insert
```
public int insert(java.lang.String key,
                  long[] meta,
                  java.lang.Object obj,
                  int id)
```
    It checks the object and the existence of the key first. If no such key exists, it inserts the object and the metadata to the list right before the object with the id. It returns the unique ID upon success or -1 otherwise.
  - swap
```
public int swap(int id,
                int jd)
```
    swaps two objects and their metadata identified by id and jd and returns 1 for success, 0 for failure or -1 for out of bound.
  - rotate
```
public int rotate(int id)
```
    rotates the object with the id and its metadata to the end of the list and returns 1 for success, 0 for failure or -1 for out of bound.
  - set
```
public java.lang.Object set(int id,
                            java.lang.Object obj)
```
    It checks the id first. If the id is verified, it replaces the object. It returns the original object upon success or null otherwise.
  - set
```
public java.lang.Object set(java.lang.String key,
                            java.lang.Object obj)
```
    It checks the object and the existence of the key first. If the key exists, it replaces the object. It returns the original object upon success or null otherwise.
  - getID
```
public int getID(java.lang.String key)
```
    returns the id of the object on the key or null if no object on the key
  - getKey
```
public java.lang.String getKey(int id)
```
    returns the key of the id or null if no object at the id
  - replaceKey
```
public java.lang.String replaceKey(int id,
                                   java.lang.String key)
```
    replaces the key of the id and returns the original key upon success. Otherwise, it returns null to indicate failure.
  - get
```
public java.lang.Object get(int id)
```
    returns the object of the key
  - get
```
public java.lang.Object get(java.lang.String key)
```
    returns the object of the key
  - remove
```
public java.lang.Object remove(java.lang.String key)
```
    removes both the object of the key and its metadata. It returns the removed object upon success or null otherwise.
  - remove
```
public java.lang.Object remove(int id)
```
    removes both the object of the id and its metadata. It returns the removed object upon success or null otherwise.
  - containsKey
```
public boolean containsKey(java.lang.String key)
```
    returns true if the the list contains the key
  - existsID
```
public boolean existsID(int id)
```
    returns true if the assset for the id exists
  - getMetaData
```
public long[] getMetaData(java.lang.String key)
```
    returns the metadata for the object referenced by the key
  - getMetaData
```
public long[] getMetaData(int id)
```
    returns the metadata for the object of id
  - queryIDs
```
public int queryIDs(int[] ids)
```
    returns number of assets after loading the ids to the buffer in natural order
  - isFull
```
public boolean isFull()
```
  - browser
```
public Browser browser()
```
    returns a Browser for all IDs in the natural order
  - clear
```
public void clear()
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class AssetList

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssetList

Method Detail

size

getName

getCapacity

add

add

insert

swap

rotate

set

set

getID

getKey

replaceKey

get

get

remove

remove

containsKey

existsID

getMetaData

getMetaData

queryIDs

isFull

browser

clear

finalize