ProvidesTree.java revision 3831:209b0eab0e1f
1/* 2 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package com.sun.source.doctree; 27 28import java.util.List; 29 30/** 31 * 32 * A tree node for a @provides block tag. 33 * 34 * <p> 35 * @provides service-type description 36 * 37 * @since 9 38 */ 39public interface ProvidesTree extends BlockTagTree { 40 /** 41 * Returns the name of the service type being documented. 42 * @return the name of the service type 43 */ 44 ReferenceTree getServiceType(); 45 46 /** 47 * Returns a description of the service type being provided by the module. 48 * @return the description 49 */ 50 List<? extends DocTree> getDescription(); 51} 52