Devon4jPackage (JavaDocs for devon4j-basic)

java.lang.Object
- com.devonfw.module.basic.common.api.reflect.Devon4jPackage

```
public final class Devon4jPackage
extends Object
```
This class represents a Package following the devonfw coding convetion.
After parsing a Package as Devon4jPackage you can get individual parts/segments such as compoent, layer, scope, etc.
This is useful for advanced features and tools such as service clients and exception facades, code-generators, static-code-analyzers (SonarQube plugin), etc.

Author:

hohwille

See Also:

of(String), of(Package), of(Class)

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`detail`
`static String`	`LAYER_BATCH` The batch layer.
`static String`	`LAYER_CLIENT` The client layer.
`static String`	`LAYER_COMMON` The common "layer" for cross-cutting code.
`static String`	`LAYER_DATA_ACCESS` The data-access layer.
`static String`	`LAYER_LOGIC` The logic layer.
`static String`	`LAYER_SERVICE` The service layer.
`private static Set<String>`	`LAYERS`
`private String`	`pkg`
`private static String`	`REGEX_PKG_SEPARATOR`
`private String`	`root`
`static String`	`SCOPE_API` The scope for APIs.
`static String`	`SCOPE_BASE` The scope for reusable base implementations.
`static String`	`SCOPE_IMPL` The scope for implementations.
`private int`	`scopeIndex`
`private static Set<String>`	`SCOPES`
`private String[]`	`segments`
`private Boolean`	`valid`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`Devon4jPackage(String pkg, String[] segments, String root, String detail, int scope)` Der Konstruktor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getApplication()`
`String`	`getComponent()`
`String`	`getDetail()`
`String`	`getLayer()`
`String`	`getRoot()`
`String`	`getScope()`
`String`	`getSegment(int index)`
`int`	`getSegmentCount()`
`int`	`hashCode()`
`boolean`	`isLayerBatch()`
`boolean`	`isLayerClient()`
`boolean`	`isLayerCommon()`
`boolean`	`isLayerDataAccess()`
`boolean`	`isLayerLogic()`
`boolean`	`isLayerService()`
`boolean`	`isScopeApi()`
`boolean`	`isScopeBase()`
`boolean`	`isScopeImpl()`
`boolean`	`isValid()`
`private boolean`	`isValidInternal()`
`boolean`	`isValidLayer()`
`boolean`	`isValidScope()`
`private static boolean`	`isValidSegment(String segment)`
`private String`	`joinPackage(int start)`
`private String`	`joinPackage(int start, int end)`
`static Devon4jPackage`	`of(Class<?> type)`
`static Devon4jPackage`	`of(Package javaPackage)`
`static Devon4jPackage`	`of(String packageName)`
`static Devon4jPackage`	`of(String root, String application, String component, String layer, String scope, String detail)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LAYER_COMMON
```
public static final String LAYER_COMMON
```
    The common "layer" for cross-cutting code.
    
    See Also:
    
    Constant Field Values
  - LAYER_DATA_ACCESS
```
public static final String LAYER_DATA_ACCESS
```
    The data-access layer.
    
    See Also:
    
    Constant Field Values
  - LAYER_LOGIC
```
public static final String LAYER_LOGIC
```
    The logic layer.
    
    See Also:
    
    Constant Field Values
  - LAYER_SERVICE
```
public static final String LAYER_SERVICE
```
    The service layer.
    
    See Also:
    
    Constant Field Values
  - LAYER_BATCH
```
public static final String LAYER_BATCH
```
    The batch layer.
    
    See Also:
    
    Constant Field Values
  - LAYER_CLIENT
```
public static final String LAYER_CLIENT
```
    The client layer. Please note that devonfw does not recommend to implement the client layer in Java.
    
    See Also:
    
    Constant Field Values
  - SCOPE_API
```
public static final String SCOPE_API
```
    The scope for APIs.
    
    See Also:
    
    Constant Field Values
  - SCOPE_BASE
```
public static final String SCOPE_BASE
```
    The scope for reusable base implementations.
    
    See Also:
    
    Constant Field Values
  - SCOPE_IMPL
```
public static final String SCOPE_IMPL
```
    The scope for implementations.
    
    See Also:
    
    Constant Field Values
  - LAYERS
```
private static final Set<String> LAYERS
```
  - SCOPES
```
private static final Set<String> SCOPES
```
  - REGEX_PKG_SEPARATOR
```
private static final String REGEX_PKG_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - segments
```
private final String[] segments
```
  - scopeIndex
```
private final int scopeIndex
```
  - valid
```
private Boolean valid
```
  - root
```
private transient String root
```
  - detail
```
private transient String detail
```
  - pkg
```
private transient String pkg
```
- Constructor Detail
  - Devon4jPackage
```
private Devon4jPackage(String pkg,
                       String[] segments,
                       String root,
                       String detail,
                       int scope)
```
    Der Konstruktor.
    
    Parameters:
    
    segments - - see getSegment(int).
    
    scope - - see getScope().
- Method Detail
  - isValidSegment
```
private static boolean isValidSegment(String segment)
```
  - getSegmentCount
```
public int getSegmentCount()
```
    Returns:
    
    the number of package segments.
  - getSegment
```
public String getSegment(int index)
```
    Parameters:
    
    index - the position of the requested segment. A valid index is in the range from 0 to getSegmentCount()-1.
    
    Returns:
    
    the Package segment at the given index or null if the given index is invalid.
  - isValid
```
public boolean isValid()
```
    Returns:
    
    true if this Devon4jPackage is a valid according to devonfw package conventions", false otherwise.
  - isValidInternal
```
private boolean isValidInternal()
```
  - isValidScope
```
public boolean isValidScope()
```
    Returns:
    
    true if the scope is valid (one of the predefined scopes api, base, or impl).
  - isValidLayer
```
public boolean isValidLayer()
```
    Returns:
    
    true if the layer is valid (one of the predefined scopes batch, client, common, dataaccess, logic, or service).
  - getRoot
```
public String getRoot()
```
    Returns:
    
    the root-Package of the organization or IT project owning the code.
  - getApplication
```
public String getApplication()
```
    Returns:
    
    the technical name of the application or (micro-)service.
  - getComponent
```
public String getComponent()
```
    Returns:
    
    the business component the code belongs to.
  - getLayer
```
public String getLayer()
```
    Returns:
    
    the layer the code is assigned to.
  - isLayerCommon
```
public boolean isLayerCommon()
```
    Returns:
    
    true if layer is LAYER_COMMON.
  - isLayerDataAccess
```
public boolean isLayerDataAccess()
```
    Returns:
    
    true if layer is LAYER_DATA_ACCESS.
  - isLayerLogic
```
public boolean isLayerLogic()
```
    Returns:
    
    true if layer is LAYER_LOGIC.
  - isLayerService
```
public boolean isLayerService()
```
    Returns:
    
    true if layer is LAYER_SERVICE.
  - isLayerBatch
```
public boolean isLayerBatch()
```
    Returns:
    
    true if layer is LAYER_BATCH.
  - isLayerClient
```
public boolean isLayerClient()
```
    Returns:
    
    true if layer is LAYER_CLIENT.
  - getScope
```
public String getScope()
```
    Returns:
    
    scope the scope the code is assigned to.
  - isScopeApi
```
public boolean isScopeApi()
```
    Returns:
    
    true if scope is SCOPE_API.
  - isScopeBase
```
public boolean isScopeBase()
```
    Returns:
    
    true if scope is SCOPE_BASE.
  - isScopeImpl
```
public boolean isScopeImpl()
```
    Returns:
    
    true if scope is SCOPE_IMPL.
  - getDetail
```
public String getDetail()
```
    Returns:
    
    the optional detail. Can be a single segment or multiple segments separated with dot. May be null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - joinPackage
```
private String joinPackage(int start)
```
  - joinPackage
```
private String joinPackage(int start,
                           int end)
```
  - of
```
public static Devon4jPackage of(String root,
                                String application,
                                String component,
                                String layer,
                                String scope,
                                String detail)
```
    Parameters:
    
    root - - see getRoot().
    
    application - - see getApplication().
    
    component - - see getComponent().
    
    layer - - see getLayer().
    
    scope - - see getScope().
    
    detail - - see getDetail().
    
    Returns:
    
    the Devon4jPackage for the given parameters.
  - of
```
public static Devon4jPackage of(String packageName)
```
    Parameters:
    
    packageName - the package name to parse.
    
    Returns:
    
    the parsed Devon4jPackage corresponding to the given package.
  - of
```
public static Devon4jPackage of(Package javaPackage)
```
    Parameters:
    
    javaPackage - the Package to parse.
    
    Returns:
    
    the parsed Devon4jPackage corresponding to the given package.
  - of
```
public static Devon4jPackage of(Class<?> type)
```
    Parameters:
    
    type - the Class located in the Package to parse.
    
    Returns:
    
    the parsed Devon4jPackage corresponding to the Package of the given Class.

Class Devon4jPackage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LAYER_COMMON

LAYER_DATA_ACCESS

LAYER_LOGIC

LAYER_SERVICE

LAYER_BATCH

LAYER_CLIENT

SCOPE_API

SCOPE_BASE

SCOPE_IMPL

LAYERS

SCOPES

REGEX_PKG_SEPARATOR

segments

scopeIndex

valid

root

detail

pkg

Constructor Detail

Devon4jPackage

Method Detail

isValidSegment

getSegmentCount

getSegment

isValid

isValidInternal

isValidScope

isValidLayer

getRoot

getApplication

getComponent

getLayer

isLayerCommon

isLayerDataAccess

isLayerLogic

isLayerService

isLayerBatch

isLayerClient

getScope

isScopeApi

isScopeBase

isScopeImpl

getDetail

hashCode

equals

toString

joinPackage

joinPackage

of

of

of

of