Item (OpenNARS 3.0.4-SNAPSHOT API)

java.lang.Object
- org.opennars.entity.Item<K>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Concept, Item.StringKeyItem, Task, TaskLink, TermLink
```
public abstract class Item<K>
extends Object
implements Serializable
```
An item is an object that can be put into a Bag, to participate in the resource competition of the system.
It has a key and a budget. Cannot be cloned

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Item.ItemPriorityComparator<E extends Item>

static class Item.StringKeyItem

Nested Classes
Modifier and Type	Class	Description
`static class`	`Item.ItemPriorityComparator<E extends Item>`
`static class`	`Item.StringKeyItem`

Field Summary

Fields
Modifier and Type Field Description

BudgetValue budget
The budget of the Item, consisting of 3 numbers

Fields
Modifier and Type	Field	Description
`BudgetValue`	`budget`	The budget of the Item, consisting of 3 numbers

Constructor Summary

Constructors
Modifier Constructor Description

Item()

protected Item(BudgetValue budget)
Constructor with initial budget

Constructors
Modifier	Constructor	Description
	`Item()`
`protected`	`Item(BudgetValue budget)`	Constructor with initial budget

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`decDurability(float v)`	Decrease durability value
`void`	`decPriority(float v)`	Decrease priority value
`boolean`	`equals(Object obj)`
`BudgetValue`	`getBudget()`
`float`	`getDurability()`	Get durability value
`float`	`getPriority()`	Get priority value
`static float`	`getPrioritySum(Iterable<? extends Item> c)`
`float`	`getQuality()`	Get quality value
`int`	`hashCode()`
`void`	`incDurability(float v)`	Increase durability value
`void`	`incPriority(float v)`	Increase priority value
`Item`	`merge(Item that)`	Merge with another Item with identical key
`abstract K`	`name()`	Get the current key
`void`	`setDurability(float v)`	Set durability value
`void`	`setPriority(float v)`	Set priority value
`void`	`setQuality(float v)`	Set quality value
`String`	`toString()`	Return a String representation of the Item
`String`	`toStringExternal()`	Return a String representation of the Item after simplification
`String`	`toStringExternal2()`	similar to toStringExternal but includes budget afterward
`String`	`toStringLong()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - budget
```
public final BudgetValue budget
```
    The budget of the Item, consisting of 3 numbers
- Constructor Detail
  - Item
```
public Item()
```
  - Item
```
protected Item(BudgetValue budget)
```
    Constructor with initial budget
    
    Parameters:
    
    budget - The initial budget
- Method Detail
  - name
```
public abstract K name()
```
    Get the current key
    
    Returns:
    
    Current key value
  - getPriority
```
public float getPriority()
```
    Get priority value
    
    Returns:
    
    Current priority value
  - setPriority
```
public void setPriority(float v)
```
    Set priority value
    
    Parameters:
    
    v - Set a new priority value
  - incPriority
```
public void incPriority(float v)
```
    Increase priority value
    
    Parameters:
    
    v - The amount of increase
  - decPriority
```
public void decPriority(float v)
```
    Decrease priority value
    
    Parameters:
    
    v - The amount of decrease
  - getDurability
```
public float getDurability()
```
    Get durability value
    
    Returns:
    
    Current durability value
  - setDurability
```
public void setDurability(float v)
```
    Set durability value
    
    Parameters:
    
    v - The new durability value
  - incDurability
```
public void incDurability(float v)
```
    Increase durability value
    
    Parameters:
    
    v - The amount of increase
  - decDurability
```
public void decDurability(float v)
```
    Decrease durability value
    
    Parameters:
    
    v - The amount of decrease
  - getQuality
```
public float getQuality()
```
    Get quality value
    
    Returns:
    
    The quality value
  - setQuality
```
public void setQuality(float v)
```
    Set quality value
    
    Parameters:
    
    v - The new quality value
  - merge
```
public Item merge(Item that)
```
    Merge with another Item with identical key
    
    Parameters:
    
    that - The Item to be merged
    
    Returns:
    
    the resulting Item: this or that
  - toString
```
public String toString()
```
    Return a String representation of the Item
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The String representation of the full content
  - toStringExternal
```
public String toStringExternal()
```
    Return a String representation of the Item after simplification
    
    Returns:
    
    A simplified String representation of the content
  - toStringExternal2
```
public String toStringExternal2()
```
    similar to toStringExternal but includes budget afterward
  - toStringLong
```
public String toStringLong()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getPrioritySum
```
public static float getPrioritySum(Iterable<? extends Item> c)
```
  - getBudget
```
public BudgetValue getBudget()
```

Class Item<K>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

budget

Constructor Detail

Item

Item

Method Detail

name

getPriority

setPriority

incPriority

decPriority

getDurability

setDurability

incDurability

decDurability

getQuality

setQuality

merge

toString

toStringExternal

toStringExternal2

toStringLong

hashCode

equals

getPrioritySum

getBudget