/*Copyright (C) 2010-2012 Institute for Software Integrated Systems (ISIS)
This software was developed by the Institute for Software Integrated
Systems (ISIS) at Vanderbilt University, Tennessee, USA for the 
Transformative Apps program under DARPA, Contract # HR011-10-C-0175.
The United States Government has unlimited rights to this software. 
The US government has the right to use, modify, reproduce, release, 
perform, display, or disclose computer software or computer software 
documentation in whole or in part, in any manner and for any 
purpose whatsoever, and to have or authorize others to do so.
*/
package edu.vu.isis.ammo.util;

import java.util.List;

import edu.vu.isis.ammo.core.distributor.RequestSerializer;

/**
 * Represents an item that could have been extracted from a
 * content provider.  There are two initial implementations
 * of this object; one that wraps a cursor returned from a
 * content provider, and one that wraps a ContentValues
 * object.
 * 
 * This class is used in the RequestSerializer, to provide
 * a common interface for serialization of data contained in
 * a provider and contained in an independent ContentValues
 * object (not in a content provider).
 * 
 * @author jwilliams
 */
public interface IContentItem {
    /**
     * Gets a set of all the keys.
     * @return a set of all the keys
     */
    public Set<String> keySet();
    
    /**
     * Gets the type of a key (as specified by the contract or content provider).
     * @param key
     * @return the type of the key
     */
    public RequestSerializer.FieldType getTypeForKey(String key);
    
    /**
     * Gets a value.
     * @param key the value to get
     * @return the data for the value.
     */
    public Object get(String key);
    
    /**
     * Gets a value and converts it to a Boolean.
     * 
     * @param key the value to get
     * @return the Boolean value, or null if the value is missing or not convertible
     */
    public Boolean getAsBoolean(String key);
    
    /**
     * Gets a value and converts it to a Byte.
     * 
     * @param key the value to get
     * @return the Byte value, or null if the value is missing or not convertible
     */
    public Byte getAsByte(String key);
    
    /**
     * Gets a value and converts it to a byte array.
     * 
     * @param key the value to get
     * @return the byte array, or null if the value is missing or not convertible
     */
    public byte[] getAsByteArray(String key);
    
    /**
     * Gets a value and converts it to a Double.
     * 
     * @param key the value to get
     * @return the Double value, or null if the value is missing or not convertible
     */
    public Double getAsDouble(String key);
    
    /**
     * Gets a value and converts it to a Float.
     * 
     * @param key the value to get
     * @return the Float value, or null if the value is missing or not convertible
     */
    public Float getAsFloat(String key);
    
    /**
     * Gets a value and converts it to a Integer.
     * 
     * @param key the value to get
     * @return the Integer value, or null if the value is missing or not convertible
     */
    public Integer getAsInteger(String key);
    
    /**
     * Gets a value and converts it to a Long.
     * 
     * @param key the value to get
     * @return the Long value, or null if the value is missing or not convertible
     */
    public Long getAsLong(String key);
    
    /**
     * Gets a value and converts it to a Short.
     * 
     * @param key the value to get
     * @return the Short value, or null if the value is missing or not convertible
     */
    public Short getAsShort(String key);
    
    /**
     * Gets a value and converts it to a String.
     * 
     * @param key the value to get
     * @return the String value, or null if the value is missing or not convertible
     */
    public String getAsString(String key);
    
}

@@ -660,16 +660,38 @@
 il.List;
+%0Aimport java.util.Set;
 %0A%0Aimport

Add missing import