WindowsShortcut (Katalon Studio API Specification)

com.kms.katalon.core.windows.keyword.helper.WindowsShortcut

```
public class WindowsShortcut
```
Represents a Windows shortcut (typically visible to Java only as a '.lnk' file). https://github.com/codebling/WindowsShortcuts Retrieved 2011-09-23 from http://stackoverflow.com/questions/309495/windows-shortcut-lnk-parser-in-java/672775#672775 Originally called LnkParser Additional information on the format can be found at https://web.archive.org/web/20190625054252/http://www.i2s-lab.com/Papers/The_Windows_Shortcut_File_Format.pdf Written by: (the stack overflow users, obviously!) Dword fix for offsets within file location structure by file extension by JS Lair https://stackoverflow.com/users/10297367/js-lair https://github.com/JSLair Filtering potential links by file extension by JS Lair https://stackoverflow.com/users/10297367/js-lair https://github.com/JSLair "isLocal" bit fix by Naxos84 https://stackoverflow.com/users/3157899/naxos84 https://github.com/Naxos84 Apache Commons VFS dependency removed by crysxd (why were we using that!?) https://github.com/crysxd Headerified, refactored and commented by Code Bling http://stackoverflow.com/users/675721/code-bling Network file support added by Stefan Cordes http://stackoverflow.com/users/81330/stefan-cordes Adapted by Sam Brightman http://stackoverflow.com/users/2492/sam-brightman Support for additional strings (description, relative_path, working_directory, command_line_arguments) added by Max Vollmer https://stackoverflow.com/users/9199167/max-vollmer Based on information in 'The Windows Shortcut File Format' by Jesse Hager <jessehager@iname.com> And somewhat based on code from the book 'Swing Hacks: Tips and Tools for Killer GUIs' by Joshua Marinacci and Chris Adamson ISBN: 0-596-00907-0 http://www.oreilly.com/catalog/swinghks/

Constructor Summary

Constructors
Constructor and description
`WindowsShortcut (File file)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static WindowsShortcut`	`from(String path)`
	`public String`	`getCommandLineArguments()` Returns: the command line arguments that should be used when executing the filesystem object pointed to by this shortcut, or null if no command line arguments are present
	`public String`	`getDescription()` Returns: a description for this shortcut, or null if no description is set
	`public String`	`getRealFilename()` Returns: the name of the filesystem object pointed to by this shortcut
	`public String`	`getRelativePath()` Returns: the relative path for the filesystem object pointed to by this shortcut, or null if no relative path is set
	`public String`	`getWorkingDirectory()` Returns: the working directory in which the filesystem object pointed to by this shortcut should be executed, or null if no working directory is set
	`public boolean`	`isDirectory()` Tests if the shortcut points to a directory.
	`public boolean`	`isLocal()` Tests if the shortcut points to a local resource.
	`public static boolean`	`isPotentialValidLink(File file)` Provides a quick test to see if this could be a valid link !
	`public static boolean`	`isShortcutFilePath(String path)`
	`public boolean`	`isValidShortcut()` Returns: true if the input file is a valid shortcut file; false otherwise.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public WindowsShortcut(File file)
- Method Detail
  - public static WindowsShortcut from(String path)
  - public String getCommandLineArguments()
    
    Returns:
    the command line arguments that should be used when executing the filesystem object pointed to by this shortcut, or null if no command line arguments are present
  - public String getDescription()
    
    Returns:
    a description for this shortcut, or null if no description is set
  - public String getRealFilename()
    
    Returns:
    the name of the filesystem object pointed to by this shortcut
  - public String getRelativePath()
    
    Returns:
    the relative path for the filesystem object pointed to by this shortcut, or null if no relative path is set
  - public String getWorkingDirectory()
    
    Returns:
    the working directory in which the filesystem object pointed to by this shortcut should be executed, or null if no working directory is set
  - public boolean isDirectory()
    
    Tests if the shortcut points to a directory.
    Returns:
    true if the 'directory' bit is set in this shortcut, false otherwise
  - public boolean isLocal()
    
    Tests if the shortcut points to a local resource.
    Returns:
    true if the 'local' bit is set in this shortcut, false otherwise
  - public static boolean isPotentialValidLink(File file)
    
    Provides a quick test to see if this could be a valid link ! If you try to instantiate a new WindowShortcut and the link is not valid, Exceptions may be thrown and Exceptions are extremely slow to generate, therefore any code needing to loop through several files should first check this.
    throws:
    IOException if an IOException is thrown while reading from the file
    
    Parameters:
    file - the potential link
    Returns:
    true if may be a link, false otherwise
  - public static boolean isShortcutFilePath(String path)
  - public boolean isValidShortcut()
    
    Returns:
    true if the input file is a valid shortcut file; false otherwise.

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class WindowsShortcut

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public WindowsShortcut(File file)

Method Detail

public static WindowsShortcut from(String path)

public String getCommandLineArguments()

public String getDescription()

public String getRealFilename()

public String getRelativePath()

public String getWorkingDirectory()

public boolean isDirectory()

public boolean isLocal()

public static boolean isPotentialValidLink(File file)

public static boolean isShortcutFilePath(String path)

public boolean isValidShortcut()