ImportIDSet.java revision 23cb1d1297a0807fe827a38a17c54bfe1fd05e2d
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2009 Sun Microsystems, Inc.
* Portions Copyright 2011-2015 ForgeRock AS
*/
/**
* This class manages the set of ID that are to be eventually added to an index
* tree. It is responsible for determining if the number of IDs is above
* the configured ID limit. If the limit it reached, the class stops tracking
* individual IDs and marks the set as undefined. This class is not thread safe.
*/
/** The encapsulated entryIDSet where elements are stored until reaching the limit. */
private EntryIDSet entryIDSet;
/** Key related to an ID set. */
private final ByteSequence key;
/** The index entry limit size. */
private final int indexEntryLimitSize;
/**
* Create an import ID set managing the entry limit of the provided EntryIDSet.
*
* @param key
* The key associated to this ID set
* @param entryIDSet
* The entryIDSet that will be managed by this object
* @param limit
* The index entry limit or 0 if unlimited.
* @throws NullPointerException
* if key or entryIDSet is null
* @throws IllegalArgumentException
* if limit is < 0
*/
{
this.entryIDSet = entryIDSet;
// FIXME: What to do if entryIDSet.size()> limit yet ?
}
/**
* @return <CODE>True</CODE> if an import ID set is defined.
*/
boolean isDefined()
{
return entryIDSet.isDefined();
}
void setUndefined() {
}
/**
* @param entryID The {@link EntryID} to add to an import ID set.
*/
void addEntryID(long entryID)
{
if (!isDefined()) {
return;
}
} else {
}
}
/**
* @param importIdSet The import ID set to delete.
* @throws NullPointerException if importIdSet is null
*/
{
if (!importIdSet.isDefined()) {
setUndefined();
} else if (isDefined()) {
}
}
/**
* @param importIdSet The import ID set to merge the byte array with.
* @return <CODE>true</CODE> if the import ID set reached the limit as a result of the merge.
* @throws NullPointerException if importIdSet is null
*/
{
boolean definedBeforeMerge = isDefined();
{
return definedBeforeMerge;
}
else if (isDefined())
{
}
return false;
}
/**
* @return The current size of an import ID set.
* @throws IllegalStateException if this set is undefined
*/
int size()
{
if (!isDefined()) {
throw new IllegalStateException("This ImportIDSet is undefined");
}
return (int) entryIDSet.size();
}
/**
* @return The byte string containing the DB key related to this set.
*/
{
return key;
}
return entryIDSet.iterator();
}
/**
* @return Binary representation of this ID set
*/
}
{
return entryIDSet.toString();
}
}