/*
 * Copyright (c) 2007-2022 The Cascading Authors. All Rights Reserved.
 *
 * Project and contact information: https://cascading.wensel.net/
 *
 * This file is part of the Cascading project.
 *
 * 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.
 */

package cascading.nested.core;

import cascading.tuple.type.CoercibleType;
import heretical.pointer.path.NestedPointerCompiler;

/**
 *
 */
public interface NestedCoercibleType<Node, Result> extends CoercibleType<Node>
  {
  NestedPointerCompiler<Node, Result> getNestedPointerCompiler();

  Node deepCopy( Node node );

  Node newRoot();

  /**
   * Method getNode returns a Node representation for the given value.
   * <p>
   * This is different than a type coercion. With a coercion, a String value could be parsed from XML into a DOM object.
   * <p>
   * With a literal conversion, it is assumed the String is a literal String value and is not to be parsed.
   *
   * @param value of Object
   * @return Node
   */
  default Node node( Object value )
    {
    return getNestedPointerCompiler().node( value );
    }
  }
