org.assertj.assertions.generator.description.ClassDescription Maven / Gradle / Ivy

Go to download
/**
 * 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.
 *
 * Copyright 2012-2015 the original author or authors.
 */
package org.assertj.assertions.generator.description;

import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;

/**
 * 
 * Stores the information needed to generate assertions for a given class.
 * 
 * @author Joel Costigliola
 * 
 */
public class ClassDescription implements Comparable {

  private Set gettersDescriptions;
  private Set fieldsDescriptions;
  private Set declaredGettersDescriptions;
  private Set declaredFieldsDescriptions;
  private TypeName classTypeName;
  private Class superType;

  public ClassDescription(TypeName typeName) {
    super();
    this.classTypeName = typeName;
    this.gettersDescriptions = new TreeSet();
    this.fieldsDescriptions = new TreeSet();
    this.declaredGettersDescriptions = new TreeSet();
    this.declaredFieldsDescriptions = new TreeSet();
  }

  public String getClassName() {
    return classTypeName.getSimpleName();
  }
  
  public String getFullyQualifiedClassName() {
    return classTypeName.getFullyQualifiedClassName();
  }

  public TypeName getTypeName() {
    return classTypeName;
  }

  public String getClassNameWithOuterClass() {
    return classTypeName.getSimpleNameWithOuterClass();
  }

  public String getClassNameWithOuterClassNotSeparatedByDots() {
    return classTypeName.getSimpleNameWithOuterClassNotSeparatedByDots();
  }
  
  public String getPackageName() {
    return classTypeName.getPackageName();
  }

  public Set getGettersDescriptions() {
    return gettersDescriptions;
  }

  public void addGetterDescriptions(Collection getterDescriptions) {
    this.gettersDescriptions.addAll(getterDescriptions);
  }
  
  public void addFieldDescriptions(Set fieldDescriptions) {
    this.fieldsDescriptions.addAll(fieldDescriptions);
  }
  
  public Set getFieldsDescriptions() {
    return fieldsDescriptions;
  }

  public Set getDeclaredGettersDescriptions() {
    return declaredGettersDescriptions;
  }

  public Set getDeclaredFieldsDescriptions() {
    return declaredFieldsDescriptions;
  }

  public void addDeclaredGetterDescriptions(Collection declaredGetterDescriptions) {
    this.declaredGettersDescriptions.addAll(declaredGetterDescriptions);
  }

  public void addDeclaredFieldDescriptions(Set declaredFieldDescriptions) {
    this.declaredFieldsDescriptions.addAll(declaredFieldDescriptions);
  }
  
  @Override
  public String toString() {
    return "ClassDescription [classTypeName=" + classTypeName + "]";
  }

  @Override
  public boolean equals(final Object o) {
    if (this == o) return true;
    if (!(o instanceof ClassDescription)) return false;

    final ClassDescription that = (ClassDescription) o;
    if (classTypeName != null ? !classTypeName.equals(that.classTypeName) : that.classTypeName != null) return false;
    return true;
  }

  @Override
  public int hashCode() {
    return classTypeName != null ? classTypeName.hashCode() : 0;
  }
  
  @Override
  public int compareTo(ClassDescription o) {
    return classTypeName.compareTo(o.classTypeName);
  }

  public Class getSuperType() {
    return superType;
  }

  public void setSuperType(Class superType) {
    this.superType = superType;
  }
}