/*
- * jSite2 - FcpMessage.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - FcpMessage.java - Copyright © 2008 David Roden
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* An FCP message. FCP messages consist of a name, an arbitrary amount of
* “fields” (i.e. key-value pairs), a message end marker, and optional payload
* data that follows the marker.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
*/
public class FcpMessage implements Iterable<String> {
/**
* Creates a new FCP message with the given name.
- *
+ *
* @param name
* The name of the FCP message
*/
* Creates a new FCP message with the given name and the given payload input
* stream. The payload input stream is not read until the message is sent to
* the node using {@link FcpConnection#sendMessage(FcpMessage)}.
- *
+ *
* @param name
* The name of the message
* @param payloadInputStream
/**
* Returns the name of the message.
- *
+ *
* @return The name of the message
*/
public String getName() {
/**
* Checks whether this message has a field with the given name.
- *
+ *
* @param field
* The name of the field to check for
- * @return <code>true</code> if the message has a field with the given
- * name, <code>false</code> otherwise
+ * @return <code>true</code> if the message has a field with the given name,
+ * <code>false</code> otherwise
*/
public boolean hasField(String field) {
return fields.containsKey(field);
/**
* Sets the field with the given name to the given value. If the field
* already exists in this message it is overwritten.
- *
+ *
* @param field
* The name of the field
* @param value
/**
* Returns the value of the given field.
- *
+ *
* @param field
* The name of the field
- * @return The value of the field, or <code>null</code> if there is no
- * such field
+ * @return The value of the field, or <code>null</code> if there is no such
+ * field
*/
public String getField(String field) {
return fields.get(field);
/**
* Returns all fields of this message.
- *
+ *
* @return All fields of this message
*/
public Map<String, String> getFields() {
/**
* Sets the payload input stream of the message.
- *
+ *
* @param payloadInputStream
* The payload input stream
*/
/**
* Writes this message to the given output stream. If the message has a
- * payload (i.e. {@link #payloadInputStream} is not <code>null</code>)
- * the payload is written to the given output stream after the message as
- * well. That means that this method can only be called once because on the
- * second invocation the payload input stream could not be read (again).
- *
+ * payload (i.e. {@link #payloadInputStream} is not <code>null</code>) the
+ * payload is written to the given output stream after the message as well.
+ * That means that this method can only be called once because on the second
+ * invocation the payload input stream could not be read (again).
+ *
* @param outputStream
* The output stream to write the message to
* @throws IOException
*/
public void write(OutputStream outputStream) throws IOException {
writeLine(outputStream, name);
- for (Entry<String, String> fieldEntry: fields.entrySet()) {
+ for (Entry<String, String> fieldEntry : fields.entrySet()) {
writeLine(outputStream, fieldEntry.getKey() + "=" + fieldEntry.getValue());
}
writeLine(outputStream, "EndMessage");
outputStream.flush();
if (payloadInputStream != null) {
FcpUtils.copy(payloadInputStream, outputStream);
+ outputStream.flush();
}
- outputStream.flush();
}
//
/**
* Writes the given line (followed by {@link #LINEFEED} to the given output
* stream, using UTF-8 as encoding.
- *
+ *
* @param outputStream
* The output stream to write to
* @param line