KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > editor > fold > FoldType


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.api.editor.fold;
21
22 /**
23  * Each {@link Fold} is identified by its fold type.
24  * <br>
25  * Each fold type presents a fold type acceptor as well
26  * accepting just itself.
27  *
28  * <p>
29  * As the <code>equals()</code> method is declared final
30  * (delegating to <code>super</code>) the fold types
31  * can directly be compared by using <code>==</code>
32  * operator.
33  *
34  * <p>
35  * Fold providers should export all the fold types
36  * that they provide in their APIs so that the
37  * clients can use these fold types in operations
38  * with the fold hierarchy.
39  *
40  * @author Miloslav Metelka
41  * @version 1.00
42  */

43
44 public final class FoldType {
45     
46     private final String JavaDoc description;
47     
48     /**
49      * Construct fold type with the given description.
50      *
51      * @param description textual description of the fold type.
52      * Two fold types with the same description are not equal.
53      */

54     public FoldType(String JavaDoc description) {
55         this.description = description;
56     }
57     
58     public boolean accepts(FoldType type) {
59         return (type == this);
60     }
61     
62     public String JavaDoc toString() {
63         return description;
64     }
65
66 }
67
Popular Tags