org.zeromq.util

Class ZMetadata

java.lang.Object

org.zeromq.util.ZMetadata

public class ZMetadata
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private Metadata	metadata

Constructor Summary

Constructors

Constructor and Description
ZMetadata()
ZMetadata(Metadata metadata)

Method Summary

Modifier and Type	Method and Description
byte[]	bytes()
void	clear() Removes all the properties.
boolean	containsKey(java.lang.String property) Returns true if this metada contains the property requested
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet() Returns a Set view of the properties contained in this metadata.
boolean	equals(java.lang.Object o)
java.lang.String	get(java.lang.String key)
int	hashCode()
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set<java.lang.String>	keySet()
static ZMetadata	read(java.lang.String meta)
static ZMetadata	read(ZConfig conf)
void	remove(java.lang.String key)
void	set(Metadata zapProperties)
void	set(java.lang.String key, java.lang.String value)
int	size() Returns the number of properties.
java.lang.String	toString()
java.util.Collection<java.lang.String>	values() Returns a Collection view of the values contained in this metadata.
void	write(java.io.OutputStream stream) Serialize metadata to an output stream, using the specifications of the ZMTP protocol

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metadata

private final Metadata metadata

Constructor Detail

ZMetadata

public ZMetadata()

ZMetadata

public ZMetadata(Metadata metadata)

Method Detail

keySet

public java.util.Set<java.lang.String> keySet()

get

public java.lang.String get(java.lang.String key)

set

public void set(java.lang.String key,
                java.lang.String value)

remove

public void remove(java.lang.String key)

bytes

public byte[] bytes()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Returns a Set view of the properties contained in this metadata. The set is backed by the metadata, so changes to the metadata are reflected in the set, and vice-versa. If the metadata is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a metadata property returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the metadata, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a set view of the properties contained in this metadata

values

public java.util.Collection<java.lang.String> values()

Returns a Collection view of the values contained in this metadata. The collection is backed by the metadata, so changes to the map are reflected in the collection, and vice-versa. If the metadata is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding property from the metadata, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the values contained in this map

set

public void set(Metadata zapProperties)

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Returns:

true if this map contains no key-value mappings

containsKey

public boolean containsKey(java.lang.String property)

Returns true if this metada contains the property requested

Parameters:

property - property the name of the property to be tested.

Returns:

true if this metada contains the property

clear

public void clear()

Removes all the properties. The map will be empty after this call returns.

size

public int size()

Returns the number of properties. If it contains more properties than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of properties

write

public void write(java.io.OutputStream stream)
           throws java.io.IOException

Serialize metadata to an output stream, using the specifications of the ZMTP protocol

 property = name value
 name = OCTET 1*255name-char
 name-char = ALPHA | DIGIT | "-" | "_" | "." | "+"
 value = 4OCTET *OCTET       ; Size in network byte order
 

Parameters:

stream - the output stream

Throws:

java.io.IOException - if an I/O error occurs.

java.lang.IllegalStateException - if one of the properties name size is bigger than 255

read

public static ZMetadata read(java.lang.String meta)

read

public static ZMetadata read(ZConfig conf)