001/*
002 * Copyright (c) 2016-2017 Chris K Wensel. All Rights Reserved.
003 *
004 * Project and contact information: http://www.cascading.org/
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.core;
022
023/**
024 * Class CopySpec is used to declare a mapping of parts of one nested object into a new or existing nested object type.
025 * <p>
026 * To map fields into a nested object, see {@link BuildSpec} and related operations.
027 * <p>
028 * When using a CopySpec, you are declaring which sub-trees from an existing nested object are copied into
029 * another nested object.
030 * <p>
031 * When a CopySpec is created, the target root location of all the values must be declared, or all values will
032 * be placed immediately below the root object.
033 * <p>
034 * For example, you want to copy a person named {@code John Doe} into a JSON object.
035 * <p>
036 * {@code
037 * new CopySpec().from( "/people/*", new JSONStringPointerFilter( "/person/name", "John Doe" ) );
038 * }
039 * <p>
040 * This example assumes the {@code people} object is an array of {@code person} objects.
041 */
042public class CopySpec extends heretical.pointer.operation.CopySpec<CopySpec>
043  {
044  public CopySpec()
045    {
046    }
047
048  public CopySpec( String intoPointer )
049    {
050    super( intoPointer );
051    }
052  }