binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/type/builder/MethodSignatureBuilder.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.model.api.type.builder;
   9
  10 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  11 import org.opendaylight.mdsal.binding.model.api.Type;
  12
  13 /**
  14  * Method Signature Builder serves solely for building Method Signature and
  15  * returning the <code>new</code> instance of Method Signature. <br>
  16  * By definition of {@link MethodSignature} the Method in java MUST contain
  17  * Name, Return Type and Access Modifier. By default the Access Modifier can be
  18  * set to public. The Method Signature builder does not contain method for
  19  * addName due to enforce reason that MethodSignatureBuilder SHOULD be
  20  * instantiated only once with defined method name. <br>
  21  * The methods as {@link #addAnnotation(String, String)} and
  22  * {@link #setComment(String)} can be used as optional because not all methods
  23  * MUST contain annotation or comment definitions.
  24  *
  25  * @see MethodSignature
  26  */
  27 public interface MethodSignatureBuilder extends TypeMemberBuilder<MethodSignatureBuilder> {
  28     /**
  29      * Sets the flag for declaration of method as abstract or non abstract. If
  30      * the flag <code>isAbstract == true</code> The instantiated Method
  31      * Signature MUST have return value for {@link MethodSignature#isAbstract()}
  32      * also equals to <code>true</code>.
  33      *
  34      * @param isAbstract is abstract flag
  35      */
  36     MethodSignatureBuilder setAbstract(boolean isAbstract);
  37
  38     /**
  39      * Adds Parameter into the List of method parameters. Neither the Name or
  40      * Type of parameter can be <code>null</code>.
  41      *
  42      * <br>
  43      * In case that any of parameters are defined as <code>null</code> the
  44      * method SHOULD throw an {@link IllegalArgumentException}
  45      *
  46      * @param type Parameter Type
  47      * @param name Parameter Name
  48      */
  49     MethodSignatureBuilder addParameter(Type type, String name);
  50
  51     /**
  52      * Returns <code>new</code> <i>immutable</i> instance of Method Signature. <br>
  53      * The <code>definingType</code> param cannot be <code>null</code>. The
  54      * every method in Java MUST be declared and defined inside the scope of
  55      * <code>class</code> or <code>interface</code> definition. In case that
  56      * defining Type will be passed as <code>null</code> reference the method
  57      * SHOULD thrown {@link IllegalArgumentException}.
  58      *
  59      * @param definingType Defining Type of Method Signature
  60      * @return <code>new</code> <i>immutable</i> instance of Method Signature.
  61      */
  62     MethodSignature toInstance(Type definingType);
  63 }