SAP ABAP Class CL_FS_PATH (File System Paths)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABP_FILE (Package) File Handling
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_FS_UNIX_PATH A UNIX File System Path 20100909
2 Inheritance (c INHERITING FROM c_ref)  CL_FS_WINDOWS_PATH A WINDOWS File System Path 20100909
Properties
Class CL_FS_PATH  
Short Description File System Paths    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SABP_FILE   File Handling 
Created 20100812   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_FS_PATH has no interface implemented.
Friends
Class CL_FS_PATH has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 COMPONENTS Instance attribute Protected Type reference (TYPE) STRING_TABLE Table of path components 20100909
2 DRIVE Instance attribute Protected Type reference (TYPE) CHAR1 Drive letter 20100909
3 HOSTNAME Instance attribute Protected Type reference (TYPE) STRING Hostname for UNC paths 20100909
4 IS_ABS Instance attribute Protected Type reference (TYPE) ABAP_BOOL Is path absolute? 20100909
5 PARSE_SEPARATOR Static Attribute Public Type reference (TYPE) STRING Separator(s) for Parsing 20100909
6 PATH_KIND Instance attribute Public Type reference (TYPE) PATH_KIND_T Values see above 20100909
7 PATH_KIND_SMART Constant Public Type reference (TYPE) PATH_KIND_T 'S' Be smart about the path 20100909
8 PATH_KIND_UNIX Constant Public Type reference (TYPE) PATH_KIND_T 'U' Path is a Unix path 20100909
9 PATH_KIND_WINDOWS Constant Public Type reference (TYPE) PATH_KIND_T 'W' Path is a Windows path 20100909
10 SEPARATOR Static Attribute Public Type reference (TYPE) CHAR1 Separator for Rendering 20100909
Methods
# Method Level Visibility Method type Description Created on
1 APPEND_PATH Instance method Public Method Append a relative path to the current path object 20100909
2 APPEND_PATH_NAME Instance method Public Method Append a relative path by name 20100909
3 CLASS_CONSTRUCTOR Static method Public Constructor 20100909
4 CONSTRUCTOR Instance method Public Constructor 20100909
5 COPY Instance method Public Method Return a copy of the current path object 20100909
6 CREATE Static method Public Method Factory method for a platform specific path object 20100909
7 CREATE_FROM_LOGICAL_NAME Static method Public Method 20100909
8 CREATE_SMART_PATH Static method Public Method Factory method for a path object working on all platforms 20100909
9 GET_CURRENT_WORKING_DIR Static method Public Method Get the current working directory 20100909
10 GET_DRIVE_LETTER Instance method Public Method Get the drive letter of a Windows path 20100909
11 GET_FILE_BASE_NAME Instance method Public Method Get the base name without extension from the file name part 20100909
12 GET_FILE_EXTENSION Instance method Public Method Get the file name extension 20100909
13 GET_FILE_NAME Instance method Public Method Get the file name part of the path 20100909
14 GET_HOSTNAME Instance method Public Method Get the host name of a UNC path 20100909
15 GET_PATH_COMPONENT Instance method Public Method Get the path component of the path (w/o file name part) 20100909
16 GET_PATH_NAME Instance method Public Method Get a string representation of the path 20100909
17 GO_UP Instance method Public Method Go n levels up in the path hierarchy 20100909
18 HAS_DRIVE_LETTER Instance method Public Method Has the path a drive letter? 20100909
19 IS_ABSOLUTE Instance method Public Method Is the path an absolute path? 20100909
20 IS_EMPTY Instance method Public Method Is the path empty (e.g. / or .) 20100909
21 IS_EQUAL Instance method Public Method Are two paths equal? 20100909
22 IS_RELATIVE Instance method Public Method Is the path a relative path? 20100909
23 IS_SUBPATH_OF Instance method Public Method Is current path subpath of the other 20100909
24 IS_UNC_PATH Instance method Public Method Is the path a UNC path? 20100909
25 KM_GET_CWD Static method Private Method Kernel Method to get cwd 20101104
26 KM_NORMALIZE Static method Private Method Kernel Normalization 20101104
27 MAKE_ABSOLUTE Instance method Public Method Make path an absolute path (w. respect to a reference) 20100909
28 MAKE_RELATIVE Instance method Public Method Make path a relative path (w. respect to a reference) 20100909
29 NORMALIZE Instance method Protected Method Normalize the path object, e.g. remove unnecessary component 20100909
30 PARSE Instance method Protected Method Parse a path name 20100909
31 PATH_KIND_FROM_OPSYS Static method Public Method Get path kind from op sys value 20101104
32 PREPARE_FOR_COMPARISON Instance method Private Method Prepare current path and other path for comparison 20100909
33 SUBSTITUTE_PARAMS Instance method Private Method Substitute profile parameters in path 20100909
Events
Class CL_FS_PATH has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 PATH_KIND_T Public See coding 20100909 path_kind_t type c length 1
Method Signatures

Method APPEND_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909

Method APPEND_PATH_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Call by reference Type reference (TYPE) CLIKE 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909
2 CX_FS_PATH_ERROR 20100909

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_FS_PATH has no parameter.
Method CLASS_CONSTRUCTOR on class CL_FS_PATH has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_FS_PATH has no parameter.
Method CONSTRUCTOR on class CL_FS_PATH has no exception.

Method COPY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_FS_PATH 20100909

Method COPY on class CL_FS_PATH has no exception.

Method CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FORCE_ABSOLUTE Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20100909
2 Importing NAME Value transfer Type reference (TYPE) CLIKE 20100909
3 Importing PATH_KIND Value transfer Type reference (TYPE) PATH_KIND_T ' ' 20100909
4 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_SMART_PATH_SYNTAX 20100909

Method CREATE_FROM_LOGICAL_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing NAME Value transfer Type reference (TYPE) CLIKE 20100909
2 Importing PATH_KIND Value transfer Type reference (TYPE) PATH_KIND_T ' ' 20100909
3 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_FS_PATH_UNDEF_ENTITY 20100909

Method CREATE_SMART_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FORCE_ABSOLUTE Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20100909
2 Importing NAME Value transfer Type reference (TYPE) CLIKE 20100909
3 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_SMART_PATH_SYNTAX 20100909

Method GET_CURRENT_WORKING_DIR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DRIVE_LETTER Value transfer Type reference (TYPE) C ' ' 20100909
2 Importing PATH_KIND Value transfer Type reference (TYPE) PATH_KIND_T ' ' 20100909
3 Returning RESULT Value transfer Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_FS_PATH_NOT_DEFINED 20100909

Method GET_DRIVE_LETTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) CHAR1 20100909
# Exception Resumable Description Created on
1 CX_FS_PATH_UNDEF_ENTITY 20100909

Method GET_FILE_BASE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909

Method GET_FILE_BASE_NAME on class CL_FS_PATH has no exception.

Method GET_FILE_EXTENSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909

Method GET_FILE_EXTENSION on class CL_FS_PATH has no exception.

Method GET_FILE_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909

Method GET_FILE_NAME on class CL_FS_PATH has no exception.

Method GET_HOSTNAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909
# Exception Resumable Description Created on
1 CX_FS_PATH_UNDEF_ENTITY 20100909

Method GET_PATH_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909

Method GET_PATH_COMPONENT on class CL_FS_PATH has no exception.

Method GET_PATH_NAME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EMPTY_AS_DOT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20100909
2 Returning RESULT Value transfer Type reference (TYPE) STRING 20100909

Method GET_PATH_NAME on class CL_FS_PATH has no exception.

Method GO_UP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing LEVELS Call by reference Type reference (TYPE) NUMERIC 1 20100909

Method GO_UP on class CL_FS_PATH has no exception.

Method HAS_DRIVE_LETTER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909

Method HAS_DRIVE_LETTER on class CL_FS_PATH has no exception.

Method IS_ABSOLUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909

Method IS_ABSOLUTE on class CL_FS_PATH has no exception.

Method IS_EMPTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909

Method IS_EMPTY on class CL_FS_PATH has no exception.

Method IS_EQUAL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
2 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909
2 CX_FS_PATH_ERROR 20100909

Method IS_RELATIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909

Method IS_RELATIVE on class CL_FS_PATH has no exception.

Method IS_SUBPATH_OF Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
2 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909
2 CX_FS_PATH_ERROR 20100909

Method IS_UNC_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20100909

Method IS_UNC_PATH on class CL_FS_PATH has no exception.

Method KM_GET_CWD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DRIVE Call by reference Type reference (TYPE) CHAR1 Single-Character Flag 20101104
2 Returning RESULT Value transfer Type reference (TYPE) STRING 20101104

Method KM_GET_CWD on class CL_FS_PATH has no exception.

Method KM_NORMALIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HINT Call by reference Type reference (TYPE) CHAR1 Single-Character Flag 20101104
2 Importing PATH Call by reference Type reference (TYPE) STRING 20101104
3 Returning RESULT Value transfer Type reference (TYPE) STRING 20101104

Method KM_NORMALIZE on class CL_FS_PATH has no exception.

Method MAKE_ABSOLUTE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing INHERIT_DRIVE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20100909
2 Importing REF_PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909
2 CX_FS_PATH_ERROR 20100909

Method MAKE_RELATIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing REF_PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
# Exception Resumable Description Created on
1 CX_FS_PATHS_INCOMPATIBLE 20100909
2 CX_FS_PATH_ERROR 20100909

Method NORMALIZE Signature

Method NORMALIZE on class CL_FS_PATH has no parameter.
Method NORMALIZE on class CL_FS_PATH has no exception.

Method PARSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PATH_NAME Value transfer Type reference (TYPE) CLIKE 20100909
# Exception Resumable Description Created on
1 CX_SMART_PATH_SYNTAX 20100909

Method PATH_KIND_FROM_OPSYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing OPSYS Value transfer Type reference (TYPE) SYOPSYS Operating System of Application Server 20101104
2 Returning RESULT Value transfer Type reference (TYPE) PATH_KIND_T Single-Character Flag 20101104

Method PATH_KIND_FROM_OPSYS on class CL_FS_PATH has no exception.

Method PREPARE_FOR_COMPARISON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting MY_CMP_STR Call by reference Type reference (TYPE) STRING 20100909
2 Importing PATH Call by reference Object reference (TYPE REF TO) CL_FS_PATH 20100909
3 Exporting PATH_CMP_STR Call by reference Type reference (TYPE) STRING 20100909
# Exception Resumable Description Created on
1 CX_FS_PATH_ERROR 20100909

Method SUBSTITUTE_PARAMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing PATH_NAME Call by reference Type reference (TYPE) CLIKE 20100909
# Exception Resumable Description Created on
1 CX_SMART_PATH_SYNTAX 20100909
History
Last changed by/on SAP  20110908 
SAP Release Created in