jec-sandcat/src/com/onsoft/sandcat/builders/ParameterDescriptorBuilder.ts

JEC Sandcat - The default RESTful web services framework for GlassCat applications.

//  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
//
//   Copyright 2016-2018 Pascal ECHEMANN.
//
//   Licensed 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.

import {ParameterDescriptor} from "../reflect/ParameterDescriptor";
import {AnnotationType} from "../reflect/AnnotationType";
import {SingletonErrorFactory} from "../utils/SingletonErrorFactory";

/**
 * A helper class that creates <code>ParameterDescriptor</code> instances.
 */
export class ParameterDescriptorBuilder {

  //////////////////////////////////////////////////////////////////////////////
  // Constructor function
  //////////////////////////////////////////////////////////////////////////////

  /**
   * Creates a new <code>ParameterDescriptorBuilder</code> instance.
   */
  constructor() {
    if(ParameterDescriptorBuilder._locked ||
                                          ParameterDescriptorBuilder.INSTANCE) {
      new SingletonErrorFactory().throw(ParameterDescriptorBuilder);
    }
    ParameterDescriptorBuilder._locked = true;
  }
  
  //////////////////////////////////////////////////////////////////////////////
  // Singleton managment
  //////////////////////////////////////////////////////////////////////////////

  /**
   * Prevents <code>ParameterDescriptorBuilder</code> illegal instanciations.
   */
  private static _locked:boolean = true;

  /**
   * The <code>ParameterDescriptorBuilder</code> singleton instance reference.
   */
  private static INSTANCE:ParameterDescriptorBuilder = null;

  /**
   * Returns a reference to the <code>ParameterDescriptorBuilder</code>
   * singleton.
   *
   * @return {ParameterDescriptorBuilder} a reference to the
   *                          <code>ParameterDescriptorBuilder</code> singleton.
   */
  public static getInstance():ParameterDescriptorBuilder {
    if(ParameterDescriptorBuilder.INSTANCE === null) {
      ParameterDescriptorBuilder._locked = false;
      ParameterDescriptorBuilder.INSTANCE = new ParameterDescriptorBuilder();
    }
    return ParameterDescriptorBuilder.INSTANCE;
  }

  //////////////////////////////////////////////////////////////////////////////
  // Public methods
  //////////////////////////////////////////////////////////////////////////////

  /**
   * Creates and returns new <code>ParameterDescriptor</code> instance.
   * 
   * @param {string} methodName the name of the method for which to create this
   *                            parameter descriptor.
   * @param {AnnotationType} annotationType the decoration type of method.
   * @param {number} parameterIndex the index of the parameter in the method
   *                                signature.
   * @return {ParameterDescriptor} a new <code>ParameterDescriptor</code>
   *                               instance.
   */
  public build(methodName:string, annotationType:number, 
                            parameterIndex:AnnotationType):ParameterDescriptor {
    const paramDesc:ParameterDescriptor = new ParameterDescriptor();
    paramDesc.annotationType = annotationType;
    paramDesc.index = parameterIndex;
    paramDesc.methodName = methodName;
    return paramDesc;
  }
};