2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.model.api.type.builder;
10 import com.google.common.annotations.Beta;
11 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
12 import org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics;
13 import org.opendaylight.mdsal.binding.model.api.Type;
16 * Method Signature Builder serves solely for building Method Signature and
17 * returning the <code>new</code> instance of Method Signature. <br>
18 * By definition of {@link MethodSignature} the Method in java MUST contain
19 * Name, Return Type and Access Modifier. By default the Access Modifier can be
20 * set to public. The Method Signature builder does not contain method for
21 * addName due to enforce reason that MethodSignatureBuilder SHOULD be
22 * instantiated only once with defined method name. <br>
23 * The methods as {@link #addAnnotation(String, String)} and
24 * {@link #setComment(String)} can be used as optional because not all methods
25 * MUST contain annotation or comment definitions.
27 * @see MethodSignature
29 public interface MethodSignatureBuilder extends TypeMemberBuilder<MethodSignatureBuilder> {
31 * Sets the flag for declaration of method as abstract or non abstract. If the flag {@code isAbstract == true}
32 * the instantiated Method Signature MUST have return value for {@link MethodSignature#isAbstract()} also equals to
35 * @param isAbstract is abstract flag
37 MethodSignatureBuilder setAbstract(boolean isAbstract);
40 * Sets the flag indicating whether this is a {@code default interface} method.
42 * @param isDefault true if this signature is to represent a default method.
43 * @return this builder
45 MethodSignatureBuilder setDefault(boolean isDefault);
48 MethodSignatureBuilder setMechanics(ValueMechanics mechanics);
51 * Adds Parameter into the List of method parameters. Neither the Name or Type of parameter can be {@code null}.
54 * In case that any of parameters are defined as <code>null</code> the
55 * method SHOULD throw an {@link IllegalArgumentException}
57 * @param type Parameter Type
58 * @param name Parameter Name
60 MethodSignatureBuilder addParameter(Type type, String name);
63 * Returns <code>new</code> <i>immutable</i> instance of Method Signature. <br>
64 * The <code>definingType</code> param cannot be <code>null</code>. Every method in Java MUST be declared and
65 * defined inside the scope of <code>class</code> or <code>interface</code> definition. In case that defining Type
66 * will be passed as <code>null</code> reference the method SHOULD thrown {@link IllegalArgumentException}.
68 * @param definingType Defining Type of Method Signature
69 * @return <code>new</code> <i>immutable</i> instance of Method Signature.
71 MethodSignature toInstance(Type definingType);