com.liferay.portal.kernel.javadoc.JavadocMethodImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation

Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.

There is a newer version: 156.0.0

Show newest version

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.javadoc;

import java.lang.reflect.Method;

/**
 * @author Igor Spasic
 */
public class JavadocMethodImpl extends JavadocMethod {

	public JavadocMethodImpl(
		String servletContextName, String comment, Method method,
		String[] parameterComments, String returnComment,
		String[] throwsComments) {

		super(servletContextName, comment);

		_method = method;
		_parameterComments = parameterComments;
		_returnComment = returnComment;
		_throwsComments = throwsComments;
	}

	@Override
	public Method getMethod() {
		return _method;
	}

	@Override
	public String getParameterComment(int index) {
		if (_parameterComments == null) {
			return null;
		}

		return _parameterComments[index];
	}

	@Override
	public String getReturnComment() {
		return _returnComment;
	}

	@Override
	public String getThrowsComment(int index) {
		if (_throwsComments == null) {
			return null;
		}

		return _throwsComments[index];
	}

	private final Method _method;
	private final String[] _parameterComments;
	private final String _returnComment;
	private final String[] _throwsComments;

}