binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/ClassPlacement.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
   9
  10 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  11
  12 /**
  13  * Enumeration of possible placements for a particular type. This provides a tie-in between the {@link Generator} tree
  14  * and the layout of resulting Java classes as dictated by {@link JavaTypeName} and {@link CollisionDomain}.
  15  */
  16 enum ClassPlacement {
  17     /**
  18      * Generated class is a
  19      * <a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-7.html#jls-7.6">top level type declaration</a>.
  20      */
  21     TOP_LEVEL,
  22     /**
  23      * Generated class is a
  24      * <a href="https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.5">member type declaration</a>.
  25      */
  26     MEMBER,
  27     /**
  28      * There is no class being generated, hence placement is irrelevant.
  29      */
  30     NONE,
  31     /**
  32      * There is no class being generated, just as with {@link #NONE}, but there is at least one {@link #TOP_LEVEL}
  33      * generated class which derives its name from this {@link Generator} and is participating in the same
  34      * {@link CollisionDomain}.
  35      */
  36     PHANTOM;
  37 }