/*
* Copyright 2012 Bill La Forge
*
* This file is part of AgileWiki and is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License (LGPL) as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This code is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* or navigate to the following url http://www.gnu.org/licenses/lgpl-2.1.txt
*
* Note however that only Scala, Java and JavaScript files are being covered by LGPL.
* All other files are covered by the Common Public License (CPL).
* A copy of this license is also included and can be
* found as well at http://www.opensource.org/licenses/cpl1.0.txt
*/
package org.agilewiki.jid.scalar.vlens.string;
import org.agilewiki.jid.AppendableBytes;
import org.agilewiki.jid.ComparableKey;
import org.agilewiki.jid.ReadableBytes;
import org.agilewiki.jid.scalar.vlens.VLenScalarJid;
/**
* A JID actor that holds a String.
*/
public class StringJid
extends VLenScalarJid<String, String>
implements ComparableKey<String> {
/**
* Assign a value.
*
* @param v The new value.
* @throws Exception Any uncaught exception raised.
*/
@Override
public void setValue(String v) throws Exception {
int c = v.length() * 2;
if (len > -1)
c -= len;
value = v;
serializedBytes = null;
serializedOffset = -1;
change(c);
}
/**
* Assign a value unless one is already present.
*
* @param v The MakeValue request.
* @return True if a new value is created.
* @throws Exception Any uncaught exception raised.
*/
@Override
protected Boolean makeValue(String v) throws Exception {
if (len > -1)
return false;
int c = v.length() * 2;
if (len > -1)
c -= len;
value = v;
serializedBytes = null;
serializedOffset = -1;
change(c);
return true;
}
/**
* Returns the value held by this component.
*
* @return The value held by this component, or null.
*/
public String getValue() {
if (len == -1)
return null;
if (value != null)
return value;
ReadableBytes readableBytes = readable();
skipLen(readableBytes);
value = readableBytes.readString(len);
return value;
}
/**
* Serialize the persistent data.
*
* @param appendableBytes The wrapped byte array into which the persistent data is to be serialized.
*/
@Override
protected void serialize(AppendableBytes appendableBytes) {
if (len == -1)
saveLen(appendableBytes);
else
appendableBytes.writeString(value);
}
/**
* Compares the key or value;
*
* @param o The comparison value.
* @return The result of a compareTo(o).
*/
@Override
public int compareKeyTo(String o) {
return getValue().compareTo(o);
}
}