diff options
Diffstat (limited to 'src/java/org/apache/poi/sl/usermodel/ShapeContainer.java')
-rw-r--r-- | src/java/org/apache/poi/sl/usermodel/ShapeContainer.java | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java b/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java new file mode 100644 index 0000000000..1741a732d3 --- /dev/null +++ b/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java @@ -0,0 +1,46 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.sl.usermodel; + +import java.util.List; + + +public interface ShapeContainer<T extends Shape> extends Iterable<T> { + /** + * Returns an list containing all of the elements in this container in proper + * sequence (from first to last element). + * + * @return an list containing all of the elements in this container in proper + * sequence + */ + List<T> getShapes(); + + void addShape(T shape); + + /** + * Removes the specified shape from this sheet, if it is present + * (optional operation). If this sheet does not contain the element, + * it is unchanged. + * + * @param xShape shape to be removed from this sheet, if present + * @return <tt>true</tt> if this sheet contained the specified element + * @throws IllegalArgumentException if the type of the specified shape + * is incompatible with this sheet (optional) + */ + boolean removeShape(T shape); +} |