| James Kuszmaul | 4f3ad3c | 2019-12-01 16:35:21 -0800 | [diff] [blame] | 1 | /*----------------------------------------------------------------------------*/ |
| 2 | /* Copyright (c) 2019 FIRST. All Rights Reserved. */ |
| 3 | /* Open Source Software - may be modified and shared by FRC teams. The code */ |
| 4 | /* must be accompanied by the FIRST BSD license file in the root directory of */ |
| 5 | /* the project. */ |
| 6 | /*----------------------------------------------------------------------------*/ |
| 7 | |
| 8 | package edu.wpi.first.wpiutil.math; |
| 9 | |
| 10 | //CHECKSTYLE.OFF: ImportOrder |
| 11 | {{REPLACEWITHIMPORTS}} |
| 12 | //CHECKSTYLE.ON |
| 13 | |
| 14 | /** |
| 15 | * A natural number expressed as a java class. |
| 16 | * The counterpart to {@link Num} that should be used as a concrete value. |
| 17 | * |
| 18 | * @param <T> The {@link Num} this represents. |
| 19 | */ |
| 20 | @SuppressWarnings({"MethodName", "unused", "PMD.TooManyMethods"}) |
| 21 | public interface Nat<T extends Num> { |
| 22 | /** |
| 23 | * The number this interface represents. |
| 24 | * |
| 25 | * @return The number backing this value. |
| 26 | */ |
| 27 | int getNum(); |