CommentAction.java

/*******************************************************************************
 * Copyright 2014 Rafael Garcia Moreno.
 * 
 * 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 com.bladecoder.engine.actions;

import com.bladecoder.engine.actions.Param.Type;
import com.bladecoder.engine.model.VerbRunner;
import com.bladecoder.engine.util.EngineLogger;

@ActionDescription(name = "Comment", value="Comment action for documentation porposes. Does nothing.")
public class CommentAction implements Action {
	@ActionProperty(required = false, type = Type.SMALL_TEXT)
	@ActionPropertyDescription("The comment.")
	private String comment;

	@Override
	public boolean run(VerbRunner cb) {
		if(EngineLogger.debugMode() && comment != null)
			EngineLogger.debug(comment);
		
		return false;
	}

}