001/*
002 * Copyright (c) 2015, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.toolkit;
027
028import javax.lang.model.element.Element;
029import javax.lang.model.element.ModuleElement;
030import javax.lang.model.element.PackageElement;
031import javax.tools.FileObject;
032
033import org.jdrupes.mdoclet.internal.doclets.toolkit.util.Utils;
034
035/**
036 * This is a pseudo-element wrapper for doc-files html contents, essentially to
037 * associate the doc-files' html documentation's {@code DocCommentTree} to an element.
038 */
039public class DocFileElement implements DocletElement {
040
041    private final PackageElement packageElement;
042    private final FileObject fo;
043
044    public DocFileElement(Utils utils, Element element, FileObject fo) {
045        this.fo = fo;
046
047        switch (element.getKind()) {
048        case MODULE:
049            ModuleElement moduleElement = (ModuleElement) element;
050            packageElement
051                = utils.elementUtils.getPackageElement(moduleElement, "");
052            break;
053
054        case PACKAGE:
055            packageElement = (PackageElement) element;
056            break;
057
058        default:
059            throw new AssertionError("unknown kind: " + element.getKind());
060        }
061    }
062
063    @Override
064    public PackageElement getPackageElement() {
065        return packageElement;
066    }
067
068    @Override
069    public FileObject getFileObject() {
070        return fo;
071    }
072
073    @Override
074    public Kind getSubKind() {
075        return Kind.DOCFILE;
076    }
077}