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.PackageElement;
029import javax.tools.FileObject;
030
031/**
032 * This is a pseudo element wrapper for the overview element, essentially to
033 * associate overview documentation's DocCommentTree to this element.
034 */
035public class OverviewElement implements DocletElement {
036
037    private final PackageElement pkg;
038    private final FileObject fo;
039
040    public OverviewElement(PackageElement pkg, FileObject fo) {
041        this.pkg = pkg;
042        this.fo = fo;
043    }
044
045    @Override
046    public PackageElement getPackageElement() {
047        return pkg;
048    }
049
050    @Override
051    public FileObject getFileObject() {
052        return fo;
053    }
054
055    @Override
056    public Kind getSubKind() {
057        return Kind.OVERVIEW;
058    }
059}