Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com
Answertopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui.validators
Class ValidatorFileName


java.lang.Object
  extended by 

org.eclipse.rse.ui.validators.ValidatorUniqueString
      extended by 
org.eclipse.rse.ui.validators.ValidatorFileName
All Implemented Interfaces:
IInputValidator, ICellEditorValidator, ISystemValidator, ISystemValidatorUniqueString
Direct Known Subclasses:
ValidatorArchiveName

public class ValidatorFileName
extends ValidatorUniqueString
implements ISystemValidator

This class is used in dialogs that prompt for a name that eventually needs to become a file on disk. Relies on Eclipse supplied method to test for folder name validity. The IInputValidator interface is used by jface's InputDialog class and numerous other platform and system classes.


Field Summary
protected  boolean fUnique
           
static int MAX_FILENAME_LENGTH
           
protected   SystemMessage msg_Invalid
           
protected   IWorkspace workspace
           
 
Fields inherited from class org.eclipse.rse.ui.validators. ValidatorUniqueString
CASE_INSENSITIVE, CASE_SENSITIVE, caseSensitive, currentMessage, existingList, msg_Empty, msg_NonUnique, QUOTE, syntaxValidator, useUpperCase
 
Constructor Summary
ValidatorFileName ()
          Use this constructor when the name need not be unique, and you just want the syntax checking.
ValidatorFileName ( Collection existingNameList)
          Use this constructor when the name must be unique.
ValidatorFileName ( String[] existingNameList)
          Use this constructor when the name must be unique.
 
Method Summary
protected  boolean checkForBadCharacters ( String newText)
          Overridable extension point to check for invalidate characters beyond what Eclipse checks for
 int getMaximumNameLength ()
          Return the max length for file names: 256
  SystemMessage isSyntaxOk ( String newText)
          Validate each character.
 void setErrorMessages ( SystemMessage msg_Empty, SystemMessage msg_NonUnique, SystemMessage msg_Invalid)
          Supply your own error message text.
  String toString ()
           
 
Methods inherited from class org.eclipse.rse.ui.validators. ValidatorUniqueString
doMessageSubstitution, getExistingNamesList, getSystemMessage, getSystemMessageText, isValid, isValid, quotedToLowerCase, setCaseSensitive, setErrorMessages, setExistingNamesList, setExistingNamesList, setUseUpperCase, validate
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.rse.ui.validators. ISystemValidator
getSystemMessage, validate
 
Methods inherited from interface org.eclipse.jface.dialogs. IInputValidator
isValid
 
Methods inherited from interface org.eclipse.jface.viewers. ICellEditorValidator
isValid
 

Field Detail

MAX_FILENAME_LENGTH

public static final int MAX_FILENAME_LENGTH
See Also:
Constant Field Values

fUnique

protected boolean fUnique

msg_Invalid

protected 
SystemMessage msg_Invalid

workspace

protected 
IWorkspace workspace
Constructor Detail

ValidatorFileName

public ValidatorFileName(
Collection existingNameList)
Use this constructor when the name must be unique.

Parameters:
existingNameList - a collection of existing names to compare against. This will not be modified by the validator.

ValidatorFileName

public ValidatorFileName(
String[] existingNameList)
Use this constructor when the name must be unique. Give the ctor a string array of existing names to compare against.


ValidatorFileName

public ValidatorFileName()
Use this constructor when the name need not be unique, and you just want the syntax checking.

Method Detail

setErrorMessages

public void setErrorMessages(
SystemMessage msg_Empty,
                             
SystemMessage msg_NonUnique,
                             
SystemMessage msg_Invalid)
Supply your own error message text. By default, messages from RSEUIPlugin resource bundle are used.

Parameters:
msg_Empty - error message when entry field is empty
msg_NonUnique - error message when value entered is not unique
msg_Invalid - error message when syntax is not valid

checkForBadCharacters

protected boolean checkForBadCharacters(
String newText)
Overridable extension point to check for invalidate characters beyond what Eclipse checks for

Returns:
true if valid, false if not

toString

public 
String toString()
Overrides:
toString in class ValidatorUniqueString

isSyntaxOk

public 
SystemMessage isSyntaxOk(
String newText)
Validate each character. Override of parent method. Override yourself to refine the error checking.

Overrides:
isSyntaxOk in class ValidatorUniqueString

getMaximumNameLength

public int getMaximumNameLength()
Return the max length for file names: 256

Specified by:
getMaximumNameLength in interface ISystemValidator
Overrides:
getMaximumNameLength in class ValidatorUniqueString

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire