View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package org.apache.commons.geometry.euclidean.twod;
    18
    19  import java.util.List;
    20
    21  import org.apache.commons.geometry.core.partitioning.BoundaryList;
    22
    23  /** {@link BoundarySource2D} implementation that uses boundaries stored in
    24   * a list. Lists given during construction are used directly; no copies are made.
    25   * Thread safety and immutability therefore depend on the underlying list and its
    26   * usage outside of this class. The boundary list cannot be modified through this
    27   * class.
    28   */
    29  public class BoundaryList2D extends BoundaryList<Vector2D, LineConvexSubset>
    30      implements BoundarySource2D {
    31
    32      /** Construct a new instance with the given list of boundaries. The
    33       * argument is used directly; no copy is made.
    34       * @param boundaries list of boundaries for the instance
    35       */
    36      public BoundaryList2D(final List<? extends LineConvexSubset> boundaries) {
    37          super(boundaries);
    38      }
    39
    40      /** Return this instance.
    41       * @return this instance
    42       */
    43      @Override
    44      public BoundaryList2D toList() {
    45          return this;
    46      }
    47  }