Jolt.Net/SpecDriven.cs

/*
 * Copyright 2013 Bazaarvoice, Inc.
 *
 * 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.
 */
using Newtonsoft.Json.Linq;

namespace Jolt.Net
{
    /**
     * Marker interface for Jolt Transforms that are based off a "spec".
     *
     * Implementations of this interface are expected to have a single arg constructor,
     * which takes an {@link object} that is the spec for the constructed instance.
     * Chainr leverages this to instantiate these objects correctly.
     *
     * Additionally, all {@link SpecDriven} implementations should mark their constructor
     * with the {@link javax.inject.Inject} annotation, so that they can be loaded via
     * Dependency Injection systems.
     *
     * All of the "stock" Jolt {@link SpecDriven} transforms are marked with {@link javax.inject.Inject}.
     *
     * Ideally, calls to the transform method are expected to be stateless and multi-thread safe.
     */
    public abstract class SpecDriven
    {
        public static string ROOT_KEY { get; } = "root";
    }
}