core/api/src/main/java/org/apache/zest/api/unitofwork/EntityTypeNotFoundException.java

/*
 * Copyright (c) 2007, Rickard Öberg. All Rights Reserved.
 * Copyright (c) 2007-2008, Niclas Hedhman. All Rights Reserved.
 * Copyright (c) 2007, Alin Dreghiciu. All Rights Reserved. 
 *
 * 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.
 *
 */
package org.apache.zest.api.unitofwork;

import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.zest.api.composite.ModelDescriptor;
import org.apache.zest.api.structure.ModuleDescriptor;

/**
 * Zest exception to be thrown in case that an entity composite
 * was not found during a lookup call.
 */
public class EntityTypeNotFoundException
    extends UnitOfWorkException
{
    private final String compositeType;

    private EntityTypeNotFoundException( String entityType, String moduleName, Stream<String> visibility )
    {
        super( "Could not find an EntityComposite of type " + entityType + " in module [" + moduleName + "].\n" +
               "\tThe following entity types are visible:\n" + visibility.collect( Collectors.joining( "\n" ) ) );
        this.compositeType = entityType;
    }

    public String compositeType()
    {
        return compositeType;
    }

    public static EntityTypeNotFoundException create( String type, ModuleDescriptor module )
    {
        return new EntityTypeNotFoundException( type,
                                                module.name(),
                                                module.findVisibleEntityTypes()
                                                    .map( item -> item.types()
                                                                      .iterator()
                                                                      .next()
                                                                      .getName() + "[" + item.module()
                                                                      .name() + "]" )
        );
    }
}