Sized.java

  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.core;

  18. /** Interface representing a geometric element with a size. The exact meaning
  19.  * of the size will vary between spaces and dimensions. For example, the size
  20.  * of a line is its length, while the size of a polygon is its area.
  21.  */
  22. public interface Sized {

  23.     /** Get the size of the instance.
  24.      * @return the size of the instance
  25.      */
  26.     double getSize();

  27.     /** Return true if the size of the instance is finite.
  28.      * @return true if the size of the instance is finite
  29.      */
  30.     default boolean isFinite() {
  31.         return Double.isFinite(getSize());
  32.     }

  33.     /** Return true if the size of the instance is infinite.
  34.      * @return true if the size of the instance is infinite
  35.      */
  36.     default boolean isInfinite() {
  37.         return Double.isInfinite(getSize());
  38.     }
  39. }