0.10/cli/src/main/java/org/apache/oodt/cas/cli/option/require/ActionDependencyRule.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.oodt.cas.cli.option.require;

//OODT imports
import org.apache.commons.lang.Validate;
import org.apache.oodt.cas.cli.action.CmdLineAction;

/**
 * A {@link RequirementRule} which links the {@link CmdLineOption} to the
 * {@link CmdLineAction} via the {@link CmdLineAction}'s name and also specifies
 * its relationship to the {@link CmdLineAction} (i.e. Required, Optional,
 * etc...).
 * 
 * @author bfoster (Brian Foster)
 */
public class ActionDependencyRule implements RequirementRule {
   String actionName;
   Relation relation;

   public ActionDependencyRule() {
   }

   public ActionDependencyRule(String actionName, Relation relation) {
      this.actionName = actionName;
      this.relation = relation;
   }

   public String getActionName() {
      return actionName;
   }

   public void setActionName(String actionName) {
      this.actionName = actionName;
   }

   public Relation getRelation() {
      return relation;
   }

   public void setRelation(Relation relation) {
      this.relation = relation;
   }

   public Relation getRelation(CmdLineAction action) {
      Validate.notNull(actionName);
      Validate.notNull(relation);
      Validate.notNull(action);

      if (action.getName().equals(actionName)) {
         return relation;
      }
      return Relation.NONE;
   }

   public String toString() {
      return actionName + " : " + relation;
   }
}