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.BuildSpec;
026import cascading.nested.core.NestedBaseBuildFunction;
027import cascading.tuple.Fields;
028import com.fasterxml.jackson.databind.JsonNode;
029import com.fasterxml.jackson.databind.node.ArrayNode;
030
031/**
032 * Class JSONBuildAsFunction provides for the ability to create new JSON objects from streamed tuple values.
033 *
034 * @see <a href=https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-03">draft-ietf-appsawg-json-pointer-03</a>
035 * @see NestedBaseBuildFunction for more details.
036 */
037public class JSONBuildAsFunction extends NestedBaseBuildFunction<JsonNode, ArrayNode>
038  {
039  /**
040   * Creates a new JSONBuildAsFunction instance.
041   *
042   * @param fieldDeclaration of Fields
043   * @param buildSpecs       of BuildSpec...
044   */
045  @ConstructorProperties({"fieldDeclaration", "buildSpecs"})
046  public JSONBuildAsFunction( Fields fieldDeclaration, BuildSpec... buildSpecs )
047    {
048    super( JSONCoercibleType.TYPE, fieldDeclaration, buildSpecs );
049    }
050
051  /**
052   * Creates a new JSONBuildAsFunction instance.
053   *
054   * @param coercibleType    of JSONCoercibleType
055   * @param fieldDeclaration of Fields
056   * @param buildSpecs       of BuildSpec...
057   */
058  @ConstructorProperties({"coercibleType", "fieldDeclaration", "buildSpecs"})
059  public JSONBuildAsFunction( JSONCoercibleType coercibleType, Fields fieldDeclaration, BuildSpec... buildSpecs )
060    {
061    super( coercibleType, fieldDeclaration, buildSpecs );
062    }
063
064  /**
065   * Method isInto returns the into of this JSONBuildAsFunction object.
066   *
067   * @return the into (type boolean) of this JSONBuildAsFunction object.
068   */
069  @Override
070  protected boolean isInto()
071    {
072    return false;
073    }
074  }