qilin.util.Numberer Maven / Gradle / Ivy
package qilin.util;
/*-
* #%L
* Soot - a J*va Optimization Framework
* %%
* Copyright (C) 2004 Ondrej Lhotak
* %%
* This program 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.1 of the
* License, or (at your option) any later version.
*
* This program 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 General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
/**
* A numberer converts objects to unique non-negative integers, and vice-versa.
*
* @author xiao, generalize the interface
*/
public interface Numberer {
/** Tells the numberer that a new object needs to be assigned a number. */
public void add(E o);
/**
* Removes the number for a given object.
*
* @param o the element
* @return true if the removal was successful, false when not
*/
public boolean remove(E o);
/**
* Should return the number that was assigned to object o that was previously passed as an
* argument to add().
*/
public long get(E o);
/** Should return the object that was assigned the number. */
public E get(long number);
/** Should return the number of objects that have been assigned numbers. */
public int size();
}