ClientKeyBlock.java

/* This code is part of Freenet. It is distributed under the GNU General
 * Public License, version 2 (or at your option any later version). See
 * http://www.gnu.org/ for further details of the GPL. */
package freenet.keys;

import java.io.IOException;

import freenet.support.api.Bucket;
import freenet.support.api.BucketFactory;

/** A KeyBlock with a ClientKey. Can be decoded. Not a child of KeyBlock because of issues with equals().
 */
public interface ClientKeyBlock {

	/** Decode with the key
	 * @param factory The BucketFactory to use to create the Bucket to return the data in.
	 * @param maxLength The maximum size of the returned data in bytes.
	 */
	Bucket decode(BucketFactory factory, int maxLength, boolean dontDecompress) throws KeyDecodeException, IOException;

	/** Does the block contain metadata? If not, it contains real data. */
	boolean isMetadata();

    /** @return The ClientKey for this key. */
    public ClientKey getClientKey();
    
    public byte[] memoryDecode() throws KeyDecodeException;
    
    /** @return The underlying KeyBlock. */
    public KeyBlock getBlock();

    /** @return The low-level Key for the block. */
	Key getKey();
	
	/** This is why ClientKeyBlock isn't instanceof KeyBlock: Two ClientKeyBlock's with the same content
	 * but different keys are not equals(), therefore a ClientKeyBlock and its KeyBlock have to be !equals
	 * too. Hence it's really a different kind of object, so not a child. */
	@Override
	public boolean equals(Object o);
	
	/** Please be consistent with equals() */
	@Override
	public int hashCode();

}