content: /*****************************************************************
   *   Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you 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
   *
   *    https://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.
   ****************************************************************/
  package org.apache.cayenne.reflect.generic;
  
  import org.apache.cayenne.access.types.ValueObjectTypeRegistry;
  import org.apache.cayenne.di.Inject;
  import org.apache.cayenne.map.EntityResolver;
  import org.apache.cayenne.map.ObjEntity;
  import org.apache.cayenne.reflect.ArcProperty;
  import org.apache.cayenne.reflect.AttributeProperty;
  import org.apache.cayenne.reflect.ClassDescriptor;
  import org.apache.cayenne.reflect.PropertyDescriptor;
  import org.apache.cayenne.reflect.PropertyVisitor;
  import org.apache.cayenne.reflect.SingletonFaultFactory;
  import org.apache.cayenne.reflect.ToManyProperty;
  import org.apache.cayenne.reflect.ToOneProperty;
  import org.apache.cayenne.unit.di.runtime.CayenneProjects;
  import org.apache.cayenne.unit.di.runtime.RuntimeCase;
  import org.apache.cayenne.unit.di.runtime.UseCayenneRuntime;
  import org.junit.Test;
  
  import static org.junit.Assert.assertTrue;
  import static org.junit.Assert.fail;
  import static org.mockito.Mockito.mock;
  
  @UseCayenneRuntime(CayenneProjects.TESTMAP_PROJECT)
  public class PersistentObjectDescriptorFactoryIT extends RuntimeCase {
  
      @Inject
      private EntityResolver resolver;
  
      @Test
      public void testVisitDeclaredProperties_IterationOrder() {
  
          PersistentObjectDescriptorFactory factory = new PersistentObjectDescriptorFactory(
                  resolver.getClassDescriptorMap(),
                  new SingletonFaultFactory(),
                  new DefaultValueComparisonStrategyFactory(mock(ValueObjectTypeRegistry.class)));
  
          for (ObjEntity e : resolver.getObjEntities()) {
              ClassDescriptor descriptor = factory.getDescriptor(e.getName());
  
              final PropertyDescriptor[] lastProcessed = new PropertyDescriptor[1];
  
              PropertyVisitor visitor = new PropertyVisitor() {
  
                  public boolean visitToOne(ToOneProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
  
                  public boolean visitToMany(ToManyProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
  
                  public boolean visitAttribute(AttributeProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
              };
  
              descriptor.visitDeclaredProperties(visitor);
          }
  
      }
  
      @Test
      public void testVisitProperties_IterationOrder() {
  
          PersistentObjectDescriptorFactory factory = new PersistentObjectDescriptorFactory(
                  resolver.getClassDescriptorMap(),
                  new SingletonFaultFactory(),
                  new DefaultValueComparisonStrategyFactory(mock(ValueObjectTypeRegistry.class)));
  
          for (ObjEntity e : resolver.getObjEntities()) {
              ClassDescriptor descriptor = factory.getDescriptor(e.getName());
  
              final PropertyDescriptor[] lastProcessed = new PropertyDescriptor[1];
  
              PropertyVisitor visitor = new PropertyVisitor() {
  
                  public boolean visitToOne(ToOneProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
  
                  public boolean visitToMany(ToManyProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
  
                  public boolean visitAttribute(AttributeProperty property) {
                      assertPropertiesAreInOrder(lastProcessed[0], property);
                      lastProcessed[0] = property;
                      return true;
                  }
              };
  
              descriptor.visitProperties(visitor);
          }
  
      }
  
      static void assertPropertiesAreInOrder(PropertyDescriptor o1,
              PropertyDescriptor o2) {
  
          if (o1 == null) {
              return;
          }
  
          if (o1 instanceof ArcProperty) {
              if (o2 instanceof ArcProperty) {
                  assertTrue("Names are not ordered: " + o1.getName()
                          + " before " + o2.getName(),
                          o1.getName().compareTo(o2.getName()) < 0);
              } else {
                  fail("Arc preceded regular property");
              }
          } else {
              if (o2 instanceof ArcProperty) {
                  // this is correct
              } else {
                  assertTrue("Names are not ordered: " + o1.getName()
                          + " before " + o2.getName(),
                          o1.getName().compareTo(o2.getName()) < 0);
              }
          }
      }
  }
  