/*
 * Copyright 2016 Timothy Brooks
 *
 * 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 net.uncontended.precipice;

public interface Precipice<Result extends Enum<Result> & Failable, Rejected extends Enum<Rejected>> {

    GuardRail<Result, Rejected> guardRail();
}

@@ -631,110 +631,593 @@
 e;%0A%0A
-public interface Precipice%3CResult extends Enum%3CResult%3E & Failable, Rejected extends Enum%3CRejected%3E%3E %7B%0A
+/**%0A * A %3Ccode%3EPrecipice%3C/code%3E is a class that has an associated GuardRail. This interface%0A * should be implemented by classes that combined the usage of a GuardRail with specialized%0A * execution logic. The only method %7B@link #guardRail()%7D should return the GuardRail associated%0A * with the implemented class. The %7B@link CallService%7D is an example of an implementation.%0A */%0Apublic interface Precipice%3CResult extends Enum%3CResult%3E & Failable, Rejected extends Enum%3CRejected%3E%3E %7B%0A%0A    /**%0A     * Return the GuardRail associated with this class.%0A     *%0A     * @return the GuardRail%0A     */
 %0A   

Add documentaiton to guard rail