ridljar.com.sun.star.uno.IMethodDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ridl Show documentation

Types for the Java Uno typesystem

There is a newer version: 24.2.3

/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

package com.sun.star.uno;


import java.lang.reflect.Method;


/**
 * The IMethodDescription allows to examine a method
 * in detail. It gives a view to java methods from a UNO point.
 *
 * @deprecated This interface does not cover all the features supported by the
 * corresponding (unpublished) implementation.  But no client code should need
 * to access this functionality, anyway.
 */
public interface IMethodDescription extends IMemberDescription {
    /**
     * Indicates if this method is oneWay,
     * respectively if this method may become executed asynchronously.
     * @return  true means may execute asynchronously .
     */
    boolean isOneway();

    /**
     * Indicates if this method is const.
     * @return true means it is const.
     */
    boolean isConst();

    /**
     * Gives any array of ITypeDescription of
     * the [in] parameters.
     * @return  the in parameters
     */
    ITypeDescription[] getInSignature();

    /**
     * Gives any array of ITypeDescription of
     * the [out] parameters.
     * @return  the out parameters
     */
    ITypeDescription[] getOutSignature();

    /**
     * Gives the ITypeDescription of
     * the return type.
     * @return  the return type ITypeDescription
     */
    ITypeDescription getReturnSignature();

    /**
     * Gives native java method of this method.
     * @return  the java methodd
     */
    Method getMethod();
}