com.swath
Class Tools.SectorSearchParameters

java.lang.Object
  extended bycom.swath.Tools.SectorSearchParameters
All Implemented Interfaces:
java.lang.Cloneable
Enclosing class:
Tools

public static final class Tools.SectorSearchParameters
extends java.lang.Object
implements java.lang.Cloneable

This class contains parameters used when searching for sectors.

Since:
SWATH 1.6.2

Constructor Summary
Tools.SectorSearchParameters()
           
 
Method Summary
 java.lang.Object clone()
           
 boolean equals(java.lang.Object obj)
           
 void setAnomaly()
          Search for sectors with anomalies.
 void setArmidMines(boolean min, int amount)
          Sets the minimum or maximum number of armid mines to search for.
 void setArmidOwner(Identity owner)
          Search for armid mines with a specific owner.
 void setBackdoor()
          Search for sectors with backdoors.
 void setBeaconText(java.lang.String text)
          Sets the beacon text to search for.
 void setDensity(boolean min, int density)
          Sets the minimum or maximum sector density to search for.
 void setFighterAmount(boolean min, int amount)
          Sets the minimum or maximum number of fighters to search for.
 void setFighterOwner(Identity owner)
          Search for fighters with a specific owner.
 void setFighterType(int type)
          Sets the type of fighters to search for.
 void setFriendly()
          Search for friendly sectors.
 void setHostile()
          Search for hostile sectors.
 void setLimpetMines(boolean min, int amount)
          Sets the minimum or maximum number of limpet mines to search for.
 void setLimpetOwner(Identity owner)
          Search for limpet mines with a specific owner.
 void setNavHaz(boolean min, int navHaz)
          Sets the minimum or maximum navigational hazard to search for.
 void setPlanets()
          Search for sectors with planets.
 void setPortName(java.lang.String name)
          Sets the port name to search for.
 void setPortType(int type)
          Sets the port type to search for.
 void setSectorNote(java.lang.String note)
          Sets the sector note to search for.
 void setShips()
          Search for sectors with ships.
 void setSpaceName(java.lang.String name)
          Sets the space name to search for.
 void setTraders()
          Search for sectors with traders.
 void setWarps(boolean min, int warps)
          Sets the minimum or maximum number of warps to search for.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Tools.SectorSearchParameters

public Tools.SectorSearchParameters()
Method Detail

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object obj)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException

setFighterAmount

public void setFighterAmount(boolean min,
                             int amount)
Sets the minimum or maximum number of fighters to search for.

Parameters:
min - true for minimum or false for maximum.
amount - The number of fighters.
Since:
SWATH 1.6.2

setFighterOwner

public void setFighterOwner(Identity owner)
Search for fighters with a specific owner.

Parameters:
owner - The owner of the fighters.
Since:
SWATH 1.6.2

setFighterType

public void setFighterType(int type)
Sets the type of fighters to search for.

Parameters:
type - The type of fighters.
Since:
SWATH 1.6.2
See Also:
Swath.TOLL_FTRS, Swath.DEFENSIVE_FTRS, Swath.OFFENSIVE_FTRS, Swath.MERCHENARY_FTRS

setArmidMines

public void setArmidMines(boolean min,
                          int amount)
Sets the minimum or maximum number of armid mines to search for.

Parameters:
min - true for minimum or false for maximum.
amount - The number of mines.
Since:
SWATH 1.6.2

setArmidOwner

public void setArmidOwner(Identity owner)
Search for armid mines with a specific owner.

Parameters:
owner - The owner of the armid mines.
Since:
SWATH 1.6.2

setLimpetMines

public void setLimpetMines(boolean min,
                           int amount)
Sets the minimum or maximum number of limpet mines to search for.

Parameters:
min - true for minimum or false for maximum.
amount - The number of mines.
Since:
SWATH 1.6.2

setLimpetOwner

public void setLimpetOwner(Identity owner)
Search for limpet mines with a specific owner.

Parameters:
owner - The owner of the limpet mines.
Since:
SWATH 1.6.2

setDensity

public void setDensity(boolean min,
                       int density)
Sets the minimum or maximum sector density to search for.

Parameters:
min - true for minimum or false for maximum.
density - The density.
Since:
SWATH 1.6.2

setNavHaz

public void setNavHaz(boolean min,
                      int navHaz)
Sets the minimum or maximum navigational hazard to search for.

Parameters:
min - true for minimum or false for maximum.
navHaz - The navigational hazard percentage.
Since:
SWATH 1.6.2

setAnomaly

public void setAnomaly()
Search for sectors with anomalies.

Since:
SWATH 1.6.2

setTraders

public void setTraders()
Search for sectors with traders.

Since:
SWATH 1.6.2

setShips

public void setShips()
Search for sectors with ships.

Since:
SWATH 1.6.2

setPlanets

public void setPlanets()
Search for sectors with planets.

Since:
SWATH 1.6.2

setWarps

public void setWarps(boolean min,
                     int warps)
Sets the minimum or maximum number of warps to search for.

Parameters:
min - true for minimum or false for maximum.
warps - The number of warps.
Since:
SWATH 1.6.2

setPortType

public void setPortType(int type)
Sets the port type to search for. The type can be one of the following:

NO_PORTNo port
0Class 0
1Class 1 (BBS)
2Class 2 (BSB)
3Class 3 (SBB)
4Class 4 (SSB)
5Class 5 (SBS)
6Class 6 (BSS)
7Class 7 (SSS)
8Class 8 (BBB)
9StarDock
PORT_UNDER_CONSTRUCTIONPort under construction
PORT_DESTROYEDDestroyed port
PORT_BLOCKEDBlocked port

Parameters:
type - The port type.
Since:
SWATH 1.6.2
See Also:
Sector.NO_PORT, Sector.PORT_UNDER_CONSTRUCTION, Sector.PORT_DESTROYED, Sector.PORT_BLOCKED

setHostile

public void setHostile()
Search for hostile sectors.

Since:
SWATH 1.7

setFriendly

public void setFriendly()
Search for friendly sectors.

Since:
SWATH 1.7

setBackdoor

public void setBackdoor()
Search for sectors with backdoors.

Since:
SWATH 1.7

setSpaceName

public void setSpaceName(java.lang.String name)
Sets the space name to search for.

Parameters:
name - The space name or a part of the name.
Since:
SWATH 1.7

setPortName

public void setPortName(java.lang.String name)
Sets the port name to search for.

Parameters:
name - The port name or a part of the name.
Since:
SWATH 1.6.2

setBeaconText

public void setBeaconText(java.lang.String text)
Sets the beacon text to search for.

Parameters:
text - The beacon text or a part of the text.
Since:
SWATH 1.6.2

setSectorNote

public void setSectorNote(java.lang.String note)
Sets the sector note to search for.

Parameters:
note - The sector note or a part of the note.
Since:
SWATH 1.6.2