src/main/java/net/pterodactylus/fcp/URIGenerated.java

   1 /*
   2  * jFCPlib - URIGenerated.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 “URIGenerated” message signals the client that an URI was generated for
  22  * a {@link ClientPut} (or {@link ClientPutDiskDir} or
  23  * {@link ClientPutComplexDir} ) request.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class URIGenerated extends BaseMessage implements Identifiable {
  28
  29         /**
  30          * Creates a new “URIGenerated” message that wraps the received message.
  31          *
  32          * @param receivedMessage
  33          *            The received message
  34          */
  35         public URIGenerated(FcpMessage receivedMessage) {
  36                 super(receivedMessage);
  37         }
  38
  39         /**
  40          * Returns the identifier of the request that generated an URI.
  41          *
  42          * @return The identifier of the request
  43          */
  44         @Override
  45         public String getIdentifier() {
  46                 return getField("Identifier");
  47         }
  48
  49         /**
  50          * Returns the URI that was generated by the request.
  51          *
  52          * @return The URI that was generated by the request
  53          */
  54         public String getURI() {
  55                 return getField("URI");
  56         }
  57
  58         /**
  59          * Returns whether the request that generated the URI is on the global
  60          * queue or on the client-local queue.
  61          *
  62          * @return <code>true</code> if the request is on the global queue,
  63          *         <code>false</code> if it is on the client-local queue
  64          */
  65         public boolean isGlobal() {
  66                 return Boolean.parseBoolean(getField("Global"));
  67         }
  68
  69 }