org.eclipse.scout.sdk/src/org/eclipse/scout/sdk/extensions/classidgenerators/ClassIdGenerationContext.java

/*******************************************************************************
 * Copyright (c) 2013 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 ******************************************************************************/
package org.eclipse.scout.sdk.extensions.classidgenerators;

import org.eclipse.jdt.core.IType;
import org.eclipse.scout.sdk.sourcebuilder.type.ITypeSourceBuilder;

/**
 * <h3>{@link ClassIdGenerationContext}</h3> Context for a ClassId generation. Holds information about the type that
 * will hold the annotation after it has been created.
 *
 * @author Matthias Villiger
 * @since 3.10.0 05.01.2014
 */
public class ClassIdGenerationContext {

  private final String m_declaringTypeFqn;

  private ITypeSourceBuilder m_parentTypeSourceBuilder;
  private IType m_declaringType;

  public ClassIdGenerationContext(ITypeSourceBuilder parentSourceBuilder) {
    m_declaringTypeFqn = parentSourceBuilder.getFullyQualifiedName();
    m_parentTypeSourceBuilder = parentSourceBuilder;
  }

  public ClassIdGenerationContext(IType declaringType) {
    m_declaringTypeFqn = declaringType.getFullyQualifiedName();
    m_declaringType = declaringType;
  }

  /**
   * @return the fully qualified name of the type that will hold the annotation after it has been created.
   */
  public String getDeclaringTypeFqn() {
    return m_declaringTypeFqn;
  }

  /**
   * Gets the source builder to which the annotation will be added.
   *
   * @return The parent source builder that will hold the annotation or null.
   */
  public ITypeSourceBuilder getParentTypeSourceBuilder() {
    return m_parentTypeSourceBuilder;
  }

  /**
   * Gets the declaring type for which the ClassId should be generated.
   *
   * @return The declaring type or null if the type does not exist yet.
   */
  public IType getDeclaringType() {
    return m_declaringType;
  }
}