/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.util.mutable;

import org.apache.lucene.util.BytesRefBuilder;

MutableValue implementation of type String. When mutating instances of this object, the caller is responsible for ensuring that any instance where exists is set to false must also have a value with a length set to 0.
/** * {@link MutableValue} implementation of type {@link String}. * When mutating instances of this object, the caller is responsible for ensuring * that any instance where <code>exists</code> is set to <code>false</code> must also * have a <code>value</code> with a length set to 0. */
public class MutableValueStr extends MutableValue { public BytesRefBuilder value = new BytesRefBuilder(); @Override public Object toObject() { assert exists || 0 == value.length(); return exists ? value.get().utf8ToString() : null; } @Override public void copy(MutableValue source) { MutableValueStr s = (MutableValueStr) source; exists = s.exists; value.copyBytes(s.value); } @Override public MutableValue duplicate() { MutableValueStr v = new MutableValueStr(); v.value.copyBytes(value); v.exists = this.exists; return v; } @Override public boolean equalsSameType(Object other) { assert exists || 0 == value.length(); MutableValueStr b = (MutableValueStr)other; return value.get().equals(b.value.get()) && exists == b.exists; } @Override public int compareSameType(Object other) { assert exists || 0 == value.length(); MutableValueStr b = (MutableValueStr)other; int c = value.get().compareTo(b.value.get()); if (c != 0) return c; if (exists == b.exists) return 0; return exists ? 1 : -1; } @Override public int hashCode() { assert exists || 0 == value.length(); return value.get().hashCode(); } }