org.jwall.apache.httpd.config.Directive Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apache-config Show documentation

A Java library for reading Apache httpd configuration files

The newest version!

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 *   Copyright (C) 2010-2014 Christian Bockermann 
 *    
 *   This file is part of the jwall.org apache-config library. The apache-config library is
 *   a parsing library to handle Apache HTTPD configuration files.
 *
 *   More information and documentation for the jwall-tools can be found at
 *   
 *                      http://www.jwall.org/apache-config
 *   
 *   This program is free software; you can redistribute it and/or modify it under
 *   the terms of the GNU General Public License as published by the Free Software
 *   Foundation; either version 3 of the License, or (at your option) any later version.
 *   
 *   This program is distributed in the hope that it will be useful, but WITHOUT ANY
 *   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 *   FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 *   You should have received a copy of the GNU General Public License along with this 
 *   program; if not, see .
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package org.jwall.apache.httpd.config;

import java.util.List;

public interface Directive
{

    public abstract String getName();

    public abstract List getArgs();

    public abstract int depth();

    public abstract int compareTo(Directive other);

    public abstract boolean isBelow(Directive other);

    public abstract String toPlainTxt();
    
    public abstract String toXML();

    public abstract Position getLocation();

    /**
     * This method returns the name of the module which provides this directive. If
     * the directive is not provided by a specific module, then "Apache" is
     * returned as the provider. 
     * 
     * @return The name of the module which provides this directive.
     */
    public abstract String getProviderName();
    
    public boolean matches( String pattern );
}