aoqi@0: /*
aoqi@0:  * Copyright (c) 2012, 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: package com.sun.tools.javadoc.api;
aoqi@0: 
aoqi@0: import com.sun.tools.javac.util.ClientCodeException;
aoqi@0: import java.util.Locale;
aoqi@0: import java.util.concurrent.atomic.AtomicBoolean;
aoqi@0: 
aoqi@0: import javax.tools.DocumentationTool.DocumentationTask;
aoqi@0: import javax.tools.JavaFileObject;
aoqi@0: 
aoqi@0: import com.sun.tools.javac.util.Context;
aoqi@0: import com.sun.tools.javadoc.Start;
aoqi@0: import java.util.Collections;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Provides access to functionality specific to the JDK documentation tool,
aoqi@0:  * javadoc.
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: public class JavadocTaskImpl implements DocumentationTask {
aoqi@0:     private final AtomicBoolean used = new AtomicBoolean();
aoqi@0: 
aoqi@0:     private final Context context;
aoqi@0:     private Class<?> docletClass;
aoqi@0:     private Iterable<String> options;
aoqi@0:     private Iterable<? extends JavaFileObject> fileObjects;
aoqi@0:     private Locale locale;
aoqi@0: 
aoqi@0:     public JavadocTaskImpl(Context context, Class<?> docletClass,
aoqi@0:             Iterable<String> options, Iterable<? extends JavaFileObject> fileObjects) {
aoqi@0:         this.context = context;
aoqi@0:         this.docletClass = docletClass;
aoqi@0: 
aoqi@0:         this.options = (options == null) ? Collections.<String>emptySet()
aoqi@0:                 : nullCheck(options);
aoqi@0:         this.fileObjects = (fileObjects == null) ? Collections.<JavaFileObject>emptySet()
aoqi@0:                 : nullCheck(fileObjects);
aoqi@0:         setLocale(Locale.getDefault());
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void setLocale(Locale locale) {
aoqi@0:         if (used.get())
aoqi@0:             throw new IllegalStateException();
aoqi@0:         this.locale = locale;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public Boolean call() {
aoqi@0:         if (!used.getAndSet(true)) {
aoqi@0:             initContext();
aoqi@0:             Start jdoc = new Start(context);
aoqi@0:             try {
aoqi@0:                 return jdoc.begin(docletClass, options, fileObjects);
aoqi@0:             } catch (ClientCodeException e) {
aoqi@0:                 throw new RuntimeException(e.getCause());
aoqi@0:             }
aoqi@0:         } else {
aoqi@0:             throw new IllegalStateException("multiple calls to method 'call'");
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void initContext() {
aoqi@0:         //initialize compiler's default locale
aoqi@0:         context.put(Locale.class, locale);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static <T> Iterable<T> nullCheck(Iterable<T> items) {
aoqi@0:         for (T item: items) {
aoqi@0:             if (item == null)
aoqi@0:                 throw new NullPointerException();
aoqi@0:         }
aoqi@0:         return items;
aoqi@0:     }
aoqi@0: }