com.gemstone.gemfire.pdx.WritablePdxInstance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

There is a newer version: 2.0-BETA

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.pdx;


/**
 * WritablePdxInstance is a {@link PdxInstance} that also supports field modification 
 * using the {@link #setField setField} method. 
 * To get a WritablePdxInstance call {@link PdxInstance#createWriter createWriter}.
 * 
 * @author darrel
 * @since 6.6
 */

public interface WritablePdxInstance extends PdxInstance {
  /**
   * Set the existing named field to the given value.
   * The setField method has copy-on-write semantics.
   *  So for the modifications to be stored in the cache the WritablePdxInstance 
   * must be put into a region after setField has been called one or more times.
   * 
   * @param fieldName
   *          name of the field whose value will be set
   * @param value
   *          value that will be assigned to the field
   * @throws PdxFieldDoesNotExistException if the named field does not exist
   * @throws PdxFieldTypeMismatchException if the type of the value is not compatible with the field
   */
  public void setField(String fieldName, Object value);
}