001/*
002 * Copyright (c) 2007-2022 The Cascading Authors. All Rights Reserved.
003 *
004 * Project and contact information: https://cascading.wensel.net/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.nested.json;
022
023import java.beans.ConstructorProperties;
024
025import cascading.nested.core.CopySpec;
026import cascading.nested.core.NestedBaseCopyFunction;
027import cascading.tuple.Fields;
028import com.fasterxml.jackson.databind.JsonNode;
029import com.fasterxml.jackson.databind.node.ArrayNode;
030
031/**
032 * Class JSONCopyIntoFunction provides for the ability to update an existing JSON objects from an existing
033 * JSON object.
034 *
035 * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
036 * @see NestedBaseCopyFunction for more details.
037 */
038public class JSONCopyIntoFunction extends NestedBaseCopyFunction<JsonNode, ArrayNode>
039  {
040  /**
041   * Creates a new JSONCopyIntoFunction instance.
042   *
043   * @param fieldDeclaration of Fields
044   * @param copySpecs        of CopySpec...
045   */
046  @ConstructorProperties({"fieldDeclaration", "copySpecs"})
047  public JSONCopyIntoFunction( Fields fieldDeclaration, CopySpec... copySpecs )
048    {
049    super( JSONCoercibleType.TYPE, fieldDeclaration, copySpecs );
050    }
051
052  /**
053   * Creates a new JSONCopyIntoFunction instance.
054   *
055   * @param coercibleType    of JSONCoercibleType
056   * @param fieldDeclaration of Fields
057   * @param copySpecs        of CopySpec...
058   */
059  @ConstructorProperties({"coercibleType", "fieldDeclaration", "copySpecs"})
060  public JSONCopyIntoFunction( JSONCoercibleType coercibleType, Fields fieldDeclaration, CopySpec... copySpecs )
061    {
062    super( coercibleType, fieldDeclaration, copySpecs );
063    }
064
065  @Override
066  protected boolean isInto()
067    {
068    return true;
069    }
070  }