XmlFileNSInfoProvider: javadoc cleanup

GitOrigin-RevId: dbbdcbddc2ef4e0ae044f9022a392e665a79c335
This commit is contained in:
Yann Cébron
2022-01-05 16:32:30 +01:00
committed by intellij-monorepo-bot
parent eb3a906bf3
commit 2fc98d1499

View File

@@ -1,39 +1,25 @@
/*
* Copyright 2000-2009 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.psi.xml;
import com.intellij.openapi.extensions.ExtensionPointName;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import com.intellij.openapi.extensions.ExtensionPointName;
/**
* Implementations of this interface add default mappings
* for namespace prefixes to namespaces for any xml file.
* Provide default mappings for namespace prefixes to namespaces for given XML file.
*/
public interface XmlFileNSInfoProvider {
ExtensionPointName<XmlFileNSInfoProvider> EP_NAME = new ExtensionPointName<>("com.intellij.xml.fileNSInfoProvider");
/**
* Provides information (if any) for default mappings of namespace prefix to namespace identifiers.
*
* @param file for which ns mapping information is requested.
* @return array of namespace prefix to namespace mappings for given file in the format [nsPrefix, namespaceId] or
* null if the interface implementation does not know about such mapping.
* Empty nsPrefix is "", nsPrefix, namespaceId should not be null, invalid mapping table is skipped.
* @return Array of namespace prefix to namespace mappings for given file in the format {@code [nsPrefix, namespaceId]} or
* {@code null} if it does not know about such mappings.
* Empty nsPrefix is {@code ""}, {@code nsPrefix}, {@code namespaceId} should not be {@code null}, invalid mapping table is skipped.
*/
@NonNls
String[] @Nullable [] getDefaultNamespaces(@NotNull XmlFile file);