Java Doc for Flags.java in  » Library » Apache-commons-validator-1.3.1-src » org » apache » commons » validator » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache commons validator 1.3.1 src » org.apache.commons.validator.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.validator.util.Flags

Flags
public class Flags implements Serializable(Code)
Represents a collection of 64 boolean (on/off) flags. Individual flags are represented by powers of 2. For example,
Flag 1 = 1
Flag 2 = 2
Flag 3 = 4
Flag 4 = 8

or using shift operator to make numbering easier:
Flag 1 = 1 << 0
Flag 2 = 1 << 1
Flag 3 = 1 << 2
Flag 4 = 1 << 3

There cannot be a flag with a value of 3 because that represents Flag 1 and Flag 2 both being on/true.


version:
   $Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $



Constructor Summary
public  Flags()
     Create a new Flags object.
public  Flags(long flags)
     Initialize a new Flags object with the given flags.

Method Summary
public  voidclear()
     Turn off all flags.
public  Objectclone()
     Clone this Flags object.
public  booleanequals(Object obj)
     Tests if two Flags objects are in the same state.
public  longgetFlags()
     Returns the current flags.
public  inthashCode()
     The hash code is based on the current state of the flags.
public  booleanisOff(long flag)
     Tests whether the given flag is off.
public  booleanisOn(long flag)
     Tests whether the given flag is on.
public  StringtoString()
     Returns a 64 length String with the first flag on the right and the 64th flag on the left.
public  voidturnOff(long flag)
     Turns off the given flag.
public  voidturnOffAll()
     Turn off all flags.
public  voidturnOn(long flag)
     Turns on the given flag.
public  voidturnOnAll()
     Turn on all 64 flags.


Constructor Detail
Flags
public Flags()(Code)
Create a new Flags object.



Flags
public Flags(long flags)(Code)
Initialize a new Flags object with the given flags.
Parameters:
  flags - collection of boolean flags to represent.




Method Detail
clear
public void clear()(Code)
Turn off all flags. This is a synonym for turnOffAll().
since:
   Validator 1.1.1



clone
public Object clone()(Code)
Clone this Flags object. a copy of this object.
See Also:   java.lang.Object.clone



equals
public boolean equals(Object obj)(Code)
Tests if two Flags objects are in the same state.
Parameters:
  obj - object being tested
See Also:   java.lang.Object.equals(java.lang.Object) whether the objects are equal.



getFlags
public long getFlags()(Code)
Returns the current flags. collection of boolean flags represented.



hashCode
public int hashCode()(Code)
The hash code is based on the current state of the flags.
See Also:   java.lang.Object.hashCode the hash code for this object.



isOff
public boolean isOff(long flag)(Code)
Tests whether the given flag is off. If the flag is not a power of 2 (ie. 3) this tests whether the combination of flags is off.
Parameters:
  flag - Flag value to check. whether the specified flag value is off.



isOn
public boolean isOn(long flag)(Code)
Tests whether the given flag is on. If the flag is not a power of 2 (ie. 3) this tests whether the combination of flags is on.
Parameters:
  flag - Flag value to check. whether the specified flag value is on.



toString
public String toString()(Code)
Returns a 64 length String with the first flag on the right and the 64th flag on the left. A 1 indicates the flag is on, a 0 means it's off. string representation of this object.



turnOff
public void turnOff(long flag)(Code)
Turns off the given flag. If the flag is not a power of 2 (ie. 3) this turns off multiple flags.
Parameters:
  flag - Flag value to turn off.



turnOffAll
public void turnOffAll()(Code)
Turn off all flags.



turnOn
public void turnOn(long flag)(Code)
Turns on the given flag. If the flag is not a power of 2 (ie. 3) this turns on multiple flags.
Parameters:
  flag - Flag value to turn on.



turnOnAll
public void turnOnAll()(Code)
Turn on all 64 flags.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.