001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2017-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031import com.unboundid.util.NotExtensible;
032import com.unboundid.util.ThreadSafety;
033import com.unboundid.util.ThreadSafetyLevel;
034
035
036
037/**
038 * This class defines an exception that may be thrown by a
039 * {@link GroupMemberIterator} if a problem is encountered while iterating
040 * through the members of a group.
041 */
042@NotExtensible()
043@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
044public abstract class GroupMemberIteratorException
045       extends Exception
046{
047  /**
048   * The serial version UID for this serializable class.
049   */
050  private static final long serialVersionUID = 1947280551464957828L;
051
052
053
054  /**
055   * Indicates whether it is possible to continue iterating through the list of
056   * group members after this exception.
057   *
058   * @return  {@code true} if it is possible to continue iterating through the
059   *          group members after this exception, or {@code false} if not.
060   */
061  public abstract boolean mayContinueIterating();
062}