Update license to GPLv3, fix header comments
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / UnknownPeerNoteType.java
1 /*
2  * jFCPlib - UnknownPeerNoteType.java - Copyright © 2008–2016 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.fcp;
19
20 /**
21  * The ”UnknownPeerNoteType” message signals the client that the type of peer
22  * note used in a previous {@link ModifyPeerNote} is unknown.
23  *
24  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
25  */
26 public class UnknownPeerNoteType extends BaseMessage {
27
28         /**
29          * Creates a new ”UnknownPeerNoteType” message that wraps the received
30          * message.
31          *
32          * @param receivedMessage
33          *            The received message
34          */
35         public UnknownPeerNoteType(FcpMessage receivedMessage) {
36                 super(receivedMessage);
37         }
38
39         /**
40          * Returns the type of peer note that is unkown.
41          *
42          * @return The unknown peer note type
43          */
44         public int getPeerNoteType() {
45                 return FcpUtils.safeParseInt(getField("PeerNoteType"));
46         }
47
48 }