001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * ------------------- 028 * TickUnitSource.java 029 * ------------------- 030 * (C) Copyright 2003-2016, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes 036 * ------- 037 * 23-Sep-2003 : Version 1 (DG); 038 * 039 */ 040 041package org.jfree.chart.axis; 042 043/** 044 * An interface used by the {@link DateAxis} and {@link NumberAxis} classes to 045 * obtain a suitable {@link TickUnit}. 046 */ 047public interface TickUnitSource { 048 049 /** 050 * Returns the smallest tick unit available in the source that is larger 051 * than {@code unit} or, if there is no larger unit, returns {@code unit}. 052 * 053 * @param unit the unit ({@code null} not permitted). 054 * 055 * @return A tick unit that is larger than the supplied unit. 056 */ 057 public TickUnit getLargerTickUnit(TickUnit unit); 058 059 /** 060 * Returns the tick unit in the collection that is greater than or equal 061 * to (in size) the specified unit. 062 * 063 * @param unit the unit. 064 * 065 * @return A unit from the collection. 066 */ 067 public TickUnit getCeilingTickUnit(TickUnit unit); 068 069 /** 070 * Returns the smallest tick unit available in the source that is greater 071 * than or equal to the specified size. If there is no such tick unit, 072 * the method should return the largest available tick in the source. 073 * 074 * @param size the size. 075 * 076 * @return A unit from the collection (never {@code null}). 077 */ 078 public TickUnit getCeilingTickUnit(double size); 079 080}