org.apache.royale.compiler.ant.config.BaseConfigVariable Maven / Gradle / Ivy
/*
*
* 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.royale.compiler.ant.config;
import org.apache.tools.ant.types.Commandline;
/**
* Provides a base class for ConfigVariable and
* RepeatableConfigVariable. This abstract class encapsulates all
* of the functionality that any ConfigVariable must have that does not
* involve "setting" it.
*
* Consumers of this class must implement the addToCommandline
* method.
*/
public abstract class BaseConfigVariable implements IOptionSource
{
/**
* Constructor.
*
* Creates a Configuration Variable with the specified OptionSpec.
*/
protected BaseConfigVariable(OptionSpec spec)
{
this.spec = spec;
}
/**
* The OptionSpec describing the names that this ConfigVariable should match.
*/
protected final OptionSpec spec;
/**
* Adds arguments to the end of cmdline corresponding to the state of this variable.
*
* @param cmdline The Commandline object to which arguments correspond to this option should be added
*/
public abstract void addToCommandline(Commandline cmdline);
/**
* @return the OptionSpec associated with this instance.
*/
public OptionSpec getSpec()
{
return spec;
}
/**
* Returns the result of calling matches() on DEFAULT_SCRIPT_LIMITS with option as the argument.
*
* @return true of option matches DEFAULT_SCRIPT_LIMITS, and false otherwise.
*/
public boolean matches(String option)
{
return spec.matches(option);
}
}