Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.util.file.match
Class Matcher

java.lang.Object
  extended by org.hyperic.util.file.match.Matcher

public class Matcher
extends java.lang.Object

Implements a powerful file/directory matcher on top of Ant's fileset classes.


Constructor Summary
Matcher()
          Construct an Matcher.
 
Method Summary
 MatchResults getMatches(MatcherConfig config)
          Get the matches for this search.
 boolean isCandidateFS(int fstype, org.hyperic.sigar.FileSystem fs, org.apache.commons.logging.Log log)
          Determine if the given filesystem is OK to search, based on the value of fstype which tells us what filesystem types we are supposed to search.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Matcher

public Matcher()
Construct an Matcher.

Method Detail

isCandidateFS

public boolean isCandidateFS(int fstype,
                             org.hyperic.sigar.FileSystem fs,
                             org.apache.commons.logging.Log log)
Determine if the given filesystem is OK to search, based on the value of fstype which tells us what filesystem types we are supposed to search.


getMatches

public MatchResults getMatches(MatcherConfig config)
                        throws MatcherInterruptedException,
                               org.hyperic.sigar.SigarException
Get the matches for this search.

Returns:
A Map representing the matches. The keys in the Map are the keys that each MatchSelector in the MatcherConfig was initialized with in its constructor. The values are Lists, where each element in the List is a String representing the full path of the matched path.
Throws:
MatcherInterruptedException - If the search was interrupted before it could be completed. In this case, you can get the matches so far by calling getMatchesSoFar on the MatcherInterruptedException object.
org.hyperic.sigar.SigarException - If an error occurs reading the available filesystems - this can only happen if the config's getFSTypes returns a value other than MatcherConfig.FS_ALL.

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.