aoqi@0: /*
aoqi@0:  * Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.javac.main;
aoqi@0: 
aoqi@0: import com.sun.tools.javac.util.Log;
aoqi@0: import com.sun.tools.javac.util.Log.PrefixKind;
aoqi@0: import java.io.File;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Helper object to be used by {@link Option#process}, providing access to
aoqi@0:  * the compilation environment.
aoqi@0:  *
aoqi@0:  * <p><b>This is NOT part of any supported API.
aoqi@0:  * If you write code that depends on this, you do so at your own
aoqi@0:  * risk.  This code and its internal interfaces are subject to change
aoqi@0:  * or deletion without notice.</b></p>
aoqi@0:  */
aoqi@0: 
aoqi@0: public abstract class OptionHelper {
aoqi@0: 
aoqi@0:     /** Get the current value of an option. */
aoqi@0:     public abstract String get(Option option);
aoqi@0: 
aoqi@0:     /** Set the value of an option. */
aoqi@0:     public abstract void put(String name, String value);
aoqi@0: 
aoqi@0:     /** Remove any prior value for an option. */
aoqi@0:     public abstract void remove(String name);
aoqi@0: 
aoqi@0:     /** Get access to the Log for the compilation. */
aoqi@0:     public abstract Log getLog();
aoqi@0: 
aoqi@0:     /** Get the name of the tool, such as "javac", to be used in info like -help. */
aoqi@0:     public abstract String getOwnName();
aoqi@0: 
aoqi@0:     /** Report an error. */
aoqi@0:     abstract void error(String key, Object... args);
aoqi@0: 
aoqi@0:     /** Record a file to be compiled. */
aoqi@0:     abstract void addFile(File f);
aoqi@0: 
aoqi@0:     /** Record the name of a class for annotation processing. */
aoqi@0:     abstract void addClassName(String s);
aoqi@0: 
aoqi@0:     /** An implementation of OptionHelper that mostly throws exceptions. */
aoqi@0:     public static class GrumpyHelper extends OptionHelper {
aoqi@0:         private final Log log;
aoqi@0: 
aoqi@0:         public GrumpyHelper(Log log) {
aoqi@0:             this.log = log;
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Log getLog() {
aoqi@0:             return log;
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public String getOwnName() {
aoqi@0:             throw new IllegalStateException();
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public String get(Option option) {
aoqi@0:             throw new IllegalArgumentException();
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void put(String name, String value) {
aoqi@0:             throw new IllegalArgumentException();
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void remove(String name) {
aoqi@0:             throw new IllegalArgumentException();
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         void error(String key, Object... args) {
aoqi@0:             throw new IllegalArgumentException(log.localize(PrefixKind.JAVAC, key, args));
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void addFile(File f) {
aoqi@0:             throw new IllegalArgumentException(f.getPath());
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void addClassName(String s) {
aoqi@0:             throw new IllegalArgumentException(s);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0: }