001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.languages.php.lang;
043:
044: /**
045: * Method Visibility.
046: * Class methods must be defined with public, private, or protected.
047: * Methods without any declaration are defined as public.
048: *
049: * @see <a href="">PHP Manual / Chapter 19. Classes and Objects (PHP 5) /
050: * Visibility / Method Visibility</a>
051: *
052: * @author Victor G. Vasilyev
053: */
054: public enum MethodVisibility {
055: /**
056: * Public declared items can be accessed everywhere.
057: */
058: PUBLIC("public") { // NOI18N
059: MethodVisibility actualVisibility() {
060: return this ;
061: }
062: },
063: /**
064: * Private limits visibility only to the class that defines the item.
065: */
066: PRIVATE("private") { // NOI18N
067: MethodVisibility actualVisibility() {
068: return this ;
069: }
070: },
071: /**
072: * Protected limits access to inherited and parent classes (and to the class
073: * that defines the item).
074: */
075: PROTECTED("protected") { // NOI18N
076: MethodVisibility actualVisibility() {
077: return this ;
078: }
079: },
080: /**
081: * Methods without any declaration are defined as public.
082: * The actualVisibility() method for this (i.e. DEFAULT) visibility
083: * returns {@link #PUBLIC}.
084: * @see #PUBLIC
085: */
086: DEFAULT("") { // NOI18N
087: MethodVisibility actualVisibility() {
088: return PUBLIC;
089: }
090: };
091:
092: MethodVisibility(String value) {
093: this .value = value;
094: }
095:
096: private final String value;
097:
098: public String value() {
099: return value;
100: }
101:
102: public static MethodVisibility getActualVisibility(
103: MethodVisibility mv) {
104: return mv.actualVisibility();
105: }
106:
107: /**
108: * Returns the actual method visibility of the underlying
109: * <code>MethodVisibility</code>.
110: *
111: * @return the actual method visibility.
112: */
113: abstract MethodVisibility actualVisibility();
114:
115: }
|