Return optionals of fields.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Fingerprintable.java
1 /*
2  * Sone - Fingerprintable.java - Copyright © 2011–2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.data;
19
20 /**
21  * Interface for objects that can create a fingerprint of themselves, e.g. to
22  * detect modifications. The fingerprint should only contain original
23  * information; derived information should not be included.
24  *
25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
26  */
27 public interface Fingerprintable {
28
29         /**
30          * Returns the fingerprint of this object.
31          *
32          * @return The fingerprint of this object
33          */
34         public String getFingerprint();
35
36 }