Component Library Documentation: Class NameChecker

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sap.tc.complib.namecheck
Class NameChecker

java.lang.Object
  |
  +--com.sap.tc.complib.namecheck.NameChecker

public class NameChecker
extends java.lang.Object

This class provides syntactical checking of names of different types of elements in the SAP component model (like vendor-IDs and component names).

Field Summary

static java.util.Set _reservedSegmentNames


static int ALIAS_MAX_LENGTH


static char CHAR_LABEL_SEPARATOR


static char CHAR_SEGMENT_SEPARATOR


static int COMPARTMENT_MAX_LENGTH


static java.lang.String COMPONENT_ROOT_FOLDER_NAME


static int DC_MAX_LENGTH


static int DEFCONF_MAX_LENGTH


static int PP_NAME_MAX_LENGTH


static int SC_MAX_LENGTH


static int VARIANT_MAX_LENGTH


static int VENDOR_MAX_LENGTH


Constructor Summary

NameChecker()


Method Summary

static void _checkComponentName(java.lang.String nameToBeChecked)
          Checks the name of a component (name without vendor part).

static void checkAliasName(java.lang.String nameToBeChecked)
          Checks an SC Alias name.

static void checkBuildVariantName(java.lang.String nameToBeChecked)
          Checks the name of a build variant.

static void checkCompartmentName(java.lang.String nameToBeChecked)
          Checks the name of a compartment of a development configuration.

static void checkComponentName(java.lang.String nameToBeChecked)
          Checks the name of a development component (name without vendor part).

static void checkDevelopmentConfigurationName(java.lang.String nameToBeChecked)
          Checks the name of a development configuration.

static void checkPublicPartName(java.lang.String nameToBeChecked)
          Checks the name of a public part of a component.

static void checkSoftwareComponentName(java.lang.String nameToBeChecked)
          Checks the name of a software component (name without vendor part).

static void checkVendorName(java.lang.String nameToBeChecked)
          Checks the vendor part of a component's name Vendor names consist of multiple segments sepratated by '.'

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_ROOT_FOLDER_NAME

public static java.lang.String COMPONENT_ROOT_FOLDER_NAME

COMPARTMENT_MAX_LENGTH

public static int COMPARTMENT_MAX_LENGTH

ALIAS_MAX_LENGTH

public static int ALIAS_MAX_LENGTH

SC_MAX_LENGTH

public static int SC_MAX_LENGTH

DC_MAX_LENGTH

public static int DC_MAX_LENGTH

VENDOR_MAX_LENGTH

public static int VENDOR_MAX_LENGTH

VARIANT_MAX_LENGTH

public static int VARIANT_MAX_LENGTH

DEFCONF_MAX_LENGTH

public static int DEFCONF_MAX_LENGTH

PP_NAME_MAX_LENGTH

public static int PP_NAME_MAX_LENGTH

CHAR_SEGMENT_SEPARATOR

public static final char CHAR_SEGMENT_SEPARATOR

CHAR_LABEL_SEPARATOR

public static final char CHAR_LABEL_SEPARATOR

_reservedSegmentNames

public static final java.util.Set _reservedSegmentNames

Constructor Detail

NameChecker

public NameChecker()

Method Detail

checkComponentName

public static void checkComponentName(java.lang.String nameToBeChecked)
                               throws NameCheckException

Checks the name of a development component (name without vendor part).

Component names consist of a list of segments that are separarted by '/'
There must be at least one segment
Each segment consists of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkSoftwareComponentName

public static void checkSoftwareComponentName(java.lang.String nameToBeChecked)
                                       throws NameCheckException

Checks the name of a software component (name without vendor part).

Component names consist of a list of segments that are separarted by '/'
There must be at least one segment
Each segment consists of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

_checkComponentName

public static void _checkComponentName(java.lang.String nameToBeChecked)
                                throws NameCheckException

Checks the name of a component (name without vendor part).

Component names consist of a list of segments that are separarted by '/'
There must be at least one segment
Each segment consists of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkVendorName

public static void checkVendorName(java.lang.String nameToBeChecked)
                            throws NameCheckException

Checks the vendor part of a component's name Vendor names consist of multiple segments sepratated by '.'
(usually it is an internet domain name owned by the organization e.g. 'sap.com').

Each segment consist of the characters A..Z | a...z | 0..9 |'-' .
There must be at least one segment.
A segment must not begin or end with '-'.
The last segment must begin with a letter.

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkPublicPartName

public static void checkPublicPartName(java.lang.String nameToBeChecked)
                                throws NameCheckException

Checks the name of a public part of a component. Allowed names consist of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkCompartmentName

public static void checkCompartmentName(java.lang.String nameToBeChecked)
                                 throws NameCheckException

Checks the name of a compartment of a development configuration. Allowed names consist of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkAliasName

public static void checkAliasName(java.lang.String nameToBeChecked)
                           throws NameCheckException

Checks an SC Alias name. Allowed names consist of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | ' '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkBuildVariantName

public static void checkBuildVariantName(java.lang.String nameToBeChecked)
                                  throws NameCheckException

Checks the name of a build variant. Allowed names consist of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | ' '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct

checkDevelopmentConfigurationName

public static void checkDevelopmentConfigurationName(java.lang.String nameToBeChecked)
                                              throws NameCheckException

Checks the name of a development configuration. Allowed names consist of characters from the following set:
A..Z | a...z | 0..9 | '-' | '_' | '!' | '$'

Parameters:: nameToBeChecked - a String with the name that is to bechecked
Throws:: NameCheckException - if the name is not syntactically correct