001    /*
002     * Copyright 2010-2013 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.jet.lang.resolve.java.structure;
018    
019    import org.jetbrains.annotations.NotNull;
020    
021    import java.util.Iterator;
022    import java.util.ServiceLoader;
023    
024    public abstract class JavaSignatureFormatter {
025        private static JavaSignatureFormatter instance;
026    
027        @NotNull
028        public static JavaSignatureFormatter getInstance() {
029            if (instance == null) {
030                Iterator<JavaSignatureFormatter> iterator =
031                        ServiceLoader.load(JavaSignatureFormatter.class, JavaSignatureFormatter.class.getClassLoader()).iterator();
032                assert iterator.hasNext() : "No service found: " + JavaSignatureFormatter.class.getName();
033                instance = iterator.next();
034            }
035            return instance;
036        }
037    
038        /**
039         * @return a formatted signature of a method, showing method name and fully qualified names of its parameter types, e.g.:
040         * {@code "foo(double, java.lang.String)"}
041         */
042        @NotNull
043        public abstract String formatMethod(@NotNull JavaMethod method);
044    
045        /**
046         * @return a formatted signature of a method, showing method's containing class, return type and parameter types, all names are fully
047         * qualified, e.g.:
048         * {@code "java.lang.Class boolean isAnnotationPresent(java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;)"}
049         */
050        @NotNull
051        public abstract String getExternalName(@NotNull JavaMethod method);
052    }