components/visual-panels/core/src/java/util/com/oracle/solaris/vp/util/misc/StackUtil.java
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* 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 usr/src/OPENSOLARIS.LICENSE.
* 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 (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
*/
package com.oracle.solaris.vp.util.misc;
import java.util.NoSuchElementException;
public class StackUtil {
/**
* Removes the given element if it is at the top of the given stack.
*
* @return {@code true} if the given element was removed, {@code false}
* otherwise
*
* @param stack
* the {@code Stackable} from which to remove {@code element}
*
* @param element
* the element to remove from {@code stack}
*
* @exception NoSuchElementException
* if the model contains no elements
*/
public static <E> boolean popIfAtTop(Stackable<E> stack, E element) {
E e = stack.peekOrErr();
if (ObjectUtil.equals(e, element)) {
stack.pop();
return true;
}
return false;
}
}