/*
Pointer.java
*
* Copyright (c) 2002, Benja Fallenstein
*
* This file is part of Storm.
*
* Storm is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Storm is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
* Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with Storm; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
*/
/*
* Written by Benja Fallenstein
*/
package org.nongnu.storm;
import java.io.*;
import java.util.*;
/** Information about the history of a Storm Storm pointer.
* See Documentation/Mediaserver
for information
* about what a pointer is... XXX
*
* To retrieve a Pointer
instance,
* use IndexedPool.getPointer()
.
* @see IndexedPool
*/
public interface Pointer {
/** Get the URI of this pointer.
*/
String getURI();
/** Get the pool of this Pointer
instance.
* This is the pool data is read from and written to.
*/
IndexedPool getPool();
/** Get the set of all currently active PointerBlocks
.
*/
Set getCurrentBlocks() throws IOException;
/** Get the set of all PointerBlocks
for this pointer
* in this pool.
*/
Set getAllBlocks() throws IOException;
/** Add a new pointer block for this pointer.
* Note: Often, PointerBlock.update()
is the more convenient
* method for this task, but this method is more flexible.
* Probably, PointerBlock.update()
implementations will
* usually use this method internally.
* @param obsoleteBlocks A set of PointerBlocks to obsolete.
* @return The new pointer block.
*/
PointerBlock addPointerBlock(BlockId target, Set obsoleteBlocks)
throws IOException;
}