org.netbeans.modules.javascript2.sdoc.SDocComment Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.netbeans.modules.javascript2.sdoc;
import java.util.ArrayList;
import java.util.Collections;
import java.util.EnumMap;
import java.util.EnumSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.netbeans.modules.csl.api.OffsetRange;
import org.netbeans.modules.javascript2.doc.spi.JsModifier;
import org.netbeans.modules.javascript2.doc.spi.DocParameter;
import org.netbeans.modules.javascript2.doc.spi.JsComment;
import org.netbeans.modules.javascript2.types.api.Type;
import org.netbeans.modules.javascript2.sdoc.elements.SDocDescriptionElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocElementType;
import org.netbeans.modules.javascript2.sdoc.elements.SDocIdentifierElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocTypeDescribedElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocTypeNamedElement;
import org.netbeans.modules.javascript2.sdoc.elements.SDocTypeSimpleElement;
import org.netbeans.modules.javascript2.types.api.TypeUsage;
/**
* Represents documentation comment block of ScriptDoc.
*
* @author Martin Fousek
*/
public class SDocComment extends JsComment {
private final Map> tags = new EnumMap>(SDocElementType.class);
public SDocComment(OffsetRange offsetRange, List elements) {
super(offsetRange);
initComment(elements);
}
@Override
public List getSummary() {
List summaries = new LinkedList();
for (SDocElement sDocElement : getTagsForTypes(
new SDocElementType[]{SDocElementType.DESCRIPTION, SDocElementType.CLASS_DESCRIPTION, SDocElementType.PROJECT_DESCRIPTION})) {
summaries.add(((SDocDescriptionElement) sDocElement).getDescription());
}
return summaries;
}
@Override
public List getSyntax() {
return Collections.emptyList();
}
@Override
public DocParameter getReturnType() {
for (SDocElement sDocElement : getTagsForTypes(
new SDocElementType[]{SDocElementType.RETURN, SDocElementType.TYPE, SDocElementType.PROPERTY})) {
return (SDocTypeSimpleElement) sDocElement;
}
return null;
}
@Override
public List getParameters() {
List params = new LinkedList();
for (SDocElement jsDocElement : getTagsForType(SDocElementType.PARAM)) {
params.add((SDocTypeNamedElement) jsDocElement);
}
return params;
}
@Override
public String getDeprecated() {
if (getTagsForType(SDocElementType.DEPRECATED).isEmpty()) {
return null;
} else {
return "";
}
}
@Override
public Set getModifiers() {
Set modifiers = EnumSet.noneOf(JsModifier.class);
for (SDocElement jsDocElement : getTagsForType(SDocElementType.PRIVATE)) {
modifiers.add(JsModifier.fromString(jsDocElement.getType().toString().substring(1)));
}
return modifiers;
}
@Override
public List getThrows() {
List throwsEntries = new LinkedList();
for (SDocElement exceptionTag : getTagsForType(SDocElementType.EXCEPTION)) {
throwsEntries.add((SDocTypeDescribedElement) exceptionTag);
}
return throwsEntries;
}
@Override
public List getExtends() {
List extendsEntries = new LinkedList();
for (SDocElement extend : getTagsForType(SDocElementType.INHERITS)) {
SDocIdentifierElement ident = (SDocIdentifierElement) extend;
extendsEntries.add(new TypeUsage(ident.getIdentifier(), -1));
}
return extendsEntries;
}
@Override
public List getSee() {
List sees = new LinkedList();
for (SDocElement extend : getTagsForType(SDocElementType.SEE)) {
SDocDescriptionElement element = (SDocDescriptionElement) extend;
sees.add(element.getDescription());
}
return sees;
}
@Override
public String getSince() {
List since = getTagsForType(SDocElementType.SINCE);
if (since.isEmpty()) {
return null;
} else {
return ((SDocDescriptionElement) since.get(0)).getDescription();
}
}
@Override
public boolean isClass() {
return !getTagsForTypes(new SDocElementType[]{SDocElementType.CONSTRUCTOR}).isEmpty();
}
@Override
public boolean isConstant() {
return !getTagsForTypes(new SDocElementType[]{SDocElementType.CONSTANT}).isEmpty();
}
// @Override
// public List getAuthor() {
// List authors = new LinkedList();
// for (SDocElement extend : getTagsForType(SDocElementType.AUTHOR)) {
// SDocDescriptionElement element = (SDocDescriptionElement) extend;
// authors.add(element.getDescription());
// }
// return authors;
// }
//
// @Override
// public String getVersion() {
// List version = getTagsForType(SDocElementType.VERSION);
// if (version.isEmpty()) {
// return null;
// } else {
// return ((SDocDescriptionElement) version.get(0)).getDescription();
// }
// }
@Override
public List getExamples() {
List examples = new LinkedList();
for (SDocElement extend : getTagsForType(SDocElementType.EXAMPLE)) {
SDocDescriptionElement element = (SDocDescriptionElement) extend;
examples.add(element.getDescription());
}
return examples;
}
private void initComment(List elements) {
for (SDocElement element : elements) {
List list = tags.get(element.getType());
if (list == null) {
list = new LinkedList();
tags.put(element.getType(), list);
}
tags.get(element.getType()).add(element);
}
}
/**
* Gets list of all {@code SDocTag}s inside this comment. Used just in testing use cases.
*
* @return list of {@code SDocTag}s
*/
protected List getTags() {
List allTags = new ArrayList();
for (List list : tags.values()) {
allTags.addAll(list);
}
return allTags;
}
/**
* Gets list of {@code SDocElement}s of given type.
*
* @return list of {@code SDocElement}s
*/
public List getTagsForType(SDocElementType type) {
List tagsForType = tags.get(type);
return tagsForType == null ? Collections.emptyList() : tagsForType;
}
/**
* Gets list of {@code JsDocTag}s of given types.
*
* @return list of {@code JsDocTag}s
*/
public List getTagsForTypes(SDocElementType[] types) {
List list = new LinkedList();
for (SDocElementType type : types) {
list.addAll(getTagsForType(type));
}
return list;
}
@Override
public List getProperties() {
List properties = new LinkedList();
for (SDocElement jsDocElement : getTagsForType(SDocElementType.PROPERTY)) {
if (jsDocElement instanceof SDocTypeNamedElement) {
properties.add((SDocTypeNamedElement) jsDocElement);
}
}
return properties;
}
@Override
public DocParameter getDefinedType() {
return null;
}
@Override
public List getTypes() {
return Collections.emptyList();
}
@Override
public Type getCallBack() {
return null;
}
}