org.apache.vinci.transport
Class KeyValuePair

java.lang.Object
  extended by org.apache.vinci.transport.KeyValuePair

public final class KeyValuePair
extends java.lang.Object

Object for storing each key/value within a frame. Also returned by the simple Frame positional accessor method "getKeyValuePair(int)". KeyValuePair can be considered immutable unless you use any of the VinciFrame.fset(*) methods, which may modify the value component. Generally you shouldn't have to work with KeyValuePair objects since the recommended approach to accessing Frame contents is through declarative as opposed to positional accessors.


Constructor Summary
KeyValuePair(java.lang.String mykey, FrameComponent myvalue)
           
 
Method Summary
 java.lang.String getKey()
           
 FrameComponent getValue()
           
 Frame getValueAsFrame()
           
 FrameLeaf getValueAsLeaf()
           
 java.lang.String getValueAsString()
           
 boolean isValueALeaf()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeyValuePair

public KeyValuePair(java.lang.String mykey,
                    FrameComponent myvalue)
Method Detail

getValue

public FrameComponent getValue()

getKey

public java.lang.String getKey()

isValueALeaf

public boolean isValueALeaf()

getValueAsLeaf

public FrameLeaf getValueAsLeaf()

getValueAsString

public java.lang.String getValueAsString()

getValueAsFrame

public Frame getValueAsFrame()


Copyright © 2011. All Rights Reserved.