Java Doc for NbPlatform.java in  » IDE-Netbeans » api » org » netbeans » modules » apisupport » project » universe » 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 » IDE Netbeans » api » org.netbeans.modules.apisupport.project.universe   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.netbeans.modules.apisupport.project.universe.NbPlatform NbPlatform final public class NbPlatform (Code) Represents one NetBeans platform, i.e. installation of the NB platform or IDE or some derivative product. Has a code id and can have associated sources and Javadoc, just like e.g. Java platforms. author:    Jesse Glick Field Summary final public static  int HARNESS_VERSION_50      Harness version found in 5.0. final public static  int HARNESS_VERSION_50u1      Harness version found in 5.0 update 1 and 5.5. final public static  int HARNESS_VERSION_55u1      Harness version found in 5.5 update 1. final public static  int HARNESS_VERSION_60      Harness version found in 6.0. final public static  int HARNESS_VERSION_61      Harness version found in 6.1. final public static  int HARNESS_VERSION_UNKNOWN      Unknown version - platform might be invalid, or just predate any 5.0 release version. final public static  String PLATFORM_ID_DEFAULT      final public static  String PROP_SOURCE_ROOTS      Method Summary public  void addJavadocRoot(URL root)      public static  NbPlatform addPlatform(String id, File destdir, String label)      Register a new platform. Parameters:   id - unique ID string for the platform Parameters:   destdir - destination directory (i.e. public static  NbPlatform addPlatform(String id, File destdir, File harness, String label)      Register a new platform. Parameters:   id - unique ID string for the platform Parameters:   destdir - destination directory (i.e. public  void addPropertyChangeListener(PropertyChangeListener listener)      public  void addSourceRoot(URL root)      public static  String computeDisplayName(File destdir)      Find a display name for a NetBeans platform on disk. public static synchronized  boolean contains(File destDir)      Returns whether the platform within the given directory is already registered. public static  File defaultPlatformLocation()      Get the location of the default platform, or null. static  URL[] findURLs(String path)      public  File getBundledHarnessLocation()      Get the location of the harness bundled with this platform. public static  NbPlatform getDefaultPlatform()      Get the default platform. public  File getDestDir()      Get the installation directory. public  File getHarnessLocation()      public  int getHarnessVersion()      Get the version of this platform's harness. public static  String getHarnessVersionDisplayName(int version)      Gets a quick display name for the version of a harness. NbPlatform.HARNESS_VERSION_50 etc. public  String getID()      Get a unique ID for this platform. Used e.g. public  URL[] getJavadocRoots()      Get associated Javadoc roots for this platform. Each root may contain some Javadoc sets in the usual format as subdirectories, where the subdirectory is named acc. public  String getLabel()      Get a display label suitable for the user. public  ModuleEntry getModule(String cnb)      Gets a module from the platform by name. public  ModuleEntry[] getModules()      Returns (naturally sorted) array of all module entries pertaining to this NetBeans platform. public static synchronized  NbPlatform getPlatformByDestDir(File destDir)      Find a platform by its installation directory. public static synchronized  NbPlatform getPlatformByID(String id)      Find a platform by its ID. public static synchronized  Set<NbPlatform> getPlatforms()      Get a set of all registered platforms. public  File getSourceLocationOfModule(File jar)      Find sources for a module JAR file contained in this destination directory. public  URL[] getSourceRoots()      Get associated source roots for this platform. public  boolean isDefault()      Check if this is the default platform. public static  boolean isHarness(File dir)      Check whether a given directory is really a valid harness. public static  boolean isLabelValid(String supposedLabel)      Returns whether the given label (see NbPlatform.getLabel ) is valid. public static  boolean isPlatformDirectory(File destdir)      Check whether a given directory on disk is a valid destdir as per NbPlatform.getDestDir . public static  boolean isSupportedPlatform(File destdir)      public  boolean isValid()      Test whether this platform is valid or not. public  void moveJavadocRootDown(int indexToDown)      public  void moveJavadocRootUp(int indexToUp)      public  void moveSourceRootDown(int indexToDown)      public  void moveSourceRootUp(int indexToUp)      public  void removeJavadocRoots(URL[] urlsToRemove)      public static  void removePlatform(NbPlatform plaf)      public  void removePropertyChangeListener(PropertyChangeListener listener)      public  void removeSourceRoots(URL[] urlsToRemove)      public static  void reset()      Reset cached info so unit tests can start from scratch. public  void setDestDir(File destdir)      public  void setHarnessLocation(File harness)      Set a new location for this platform's harness. public  void setJavadocRoots(URL[] roots)      public  void setSourceRoots(URL[] roots)      public  String toString()      static  String urlsToAntPath(URL[] urls)      Field Detail HARNESS_VERSION_50 final public static int HARNESS_VERSION_50(Code) Harness version found in 5.0. HARNESS_VERSION_50u1 final public static int HARNESS_VERSION_50u1(Code) Harness version found in 5.0 update 1 and 5.5. HARNESS_VERSION_55u1 final public static int HARNESS_VERSION_55u1(Code) Harness version found in 5.5 update 1. HARNESS_VERSION_60 final public static int HARNESS_VERSION_60(Code) Harness version found in 6.0. HARNESS_VERSION_61 final public static int HARNESS_VERSION_61(Code) Harness version found in 6.1. HARNESS_VERSION_UNKNOWN final public static int HARNESS_VERSION_UNKNOWN(Code) Unknown version - platform might be invalid, or just predate any 5.0 release version. PLATFORM_ID_DEFAULT final public static String PLATFORM_ID_DEFAULT(Code) PROP_SOURCE_ROOTS final public static String PROP_SOURCE_ROOTS(Code) Method Detail addJavadocRoot public void addJavadocRoot(URL root) throws IOException(Code) Add given javadoc root to the current javadoc root list and save the result into the global properties in the userdir (see PropertyUtils.putGlobalProperties ) addPlatform public static NbPlatform addPlatform(String id, File destdir, String label) throws IOException(Code) Register a new platform. Parameters:   id - unique ID string for the platform Parameters:   destdir - destination directory (i.e. top-level directory beneath which there are clusters) Parameters:   label - display label the created platform throws:   IOException - in case of problems (e.g. destination directory does not exist) addPlatform public static NbPlatform addPlatform(String id, File destdir, File harness, String label) throws IOException(Code) Register a new platform. Parameters:   id - unique ID string for the platform Parameters:   destdir - destination directory (i.e. top-level directory beneath which there are clusters) Parameters:   harness - harness directory Parameters:   label - display label the created platform throws:   IOException - in case of problems (e.g. destination directory does not exist) addPropertyChangeListener public void addPropertyChangeListener(PropertyChangeListener listener)(Code) addSourceRoot public void addSourceRoot(URL root) throws IOException(Code) Add given source root to the current source root list and save the result into the global properties in the userdir (see PropertyUtils.putGlobalProperties ) computeDisplayName public static String computeDisplayName(File destdir) throws IOException(Code) Find a display name for a NetBeans platform on disk. Parameters:   destdir - a dir passing NbPlatform.isPlatformDirectory a display name throws:   IllegalArgumentException - if NbPlatform.isPlatformDirectory was false throws:   IOException - if its labelling info could not be read contains public static synchronized boolean contains(File destDir)(Code) Returns whether the platform within the given directory is already registered. defaultPlatformLocation public static File defaultPlatformLocation()(Code) Get the location of the default platform, or null. findURLs static URL[] findURLs(String path)(Code) getBundledHarnessLocation public File getBundledHarnessLocation()(Code) Get the location of the harness bundled with this platform. getDefaultPlatform public static NbPlatform getDefaultPlatform()(Code) Get the default platform. the default platform, if there is one (usually should be) getDestDir public File getDestDir()(Code) Get the installation directory. the installation directory getHarnessLocation public File getHarnessLocation()(Code) Get the current location of this platform's harness getHarnessVersion public int getHarnessVersion()(Code) Get the version of this platform's harness. getHarnessVersionDisplayName public static String getHarnessVersionDisplayName(int version)(Code) Gets a quick display name for the version of a harness. NbPlatform.HARNESS_VERSION_50 etc. a short display name getID public String getID()(Code) Get a unique ID for this platform. Used e.g. in nbplatform.active in platform.properties. a unique ID, or null for anonymousplatforms (see NbPlatform.getPlatformByDestDir). getJavadocRoots public URL[] getJavadocRoots()(Code) Get associated Javadoc roots for this platform. Each root may contain some Javadoc sets in the usual format as subdirectories, where the subdirectory is named acc. to the code name base of the module it is documenting (using '-' in place of '.'). a list of Javadoc root URLs (may be empty but not null) getLabel public String getLabel()(Code) Get a display label suitable for the user. If not set, NbPlatform.computeDisplayName is used. The NbPlatform.isDefault default platform is specially marked. a display label getModule public ModuleEntry getModule(String cnb)(Code) Gets a module from the platform by name. getModules public ModuleEntry[] getModules()(Code) Returns (naturally sorted) array of all module entries pertaining to this NetBeans platform. This is just a convenient delegate to the ModuleList.findOrCreateModuleListFromBinaries . getPlatformByDestDir public static synchronized NbPlatform getPlatformByDestDir(File destDir)(Code) Find a platform by its installation directory. If there is a registered platform for that directory, returns it. Otherwise will create an anonymous platform ( NbPlatform.getID will be null). An anonymous platform might have sources associated with it; currently this will be true in case the dest dir is nbbuild/netbeans/ inside a netbeans.org checkout. Parameters:   the - installation directory (as in NbPlatform.getDestDir) the platform with that destination directory getPlatformByID public static synchronized NbPlatform getPlatformByID(String id)(Code) Find a platform by its ID. Parameters:   id - an ID (as in NbPlatform.getID) the platform with that ID, or null getPlatforms public static synchronized Set<NbPlatform> getPlatforms()(Code) Get a set of all registered platforms. getSourceLocationOfModule public File getSourceLocationOfModule(File jar)(Code) Find sources for a module JAR file contained in this destination directory. Parameters:   jar - a JAR file in the destination directory the directory of sources for this module (a project directory), or null getSourceRoots public URL[] getSourceRoots()(Code) Get associated source roots for this platform. Each root could be a netbeans.org source checkout or a module suite project directory. a list of source root URLs (may be empty but not null) isDefault public boolean isDefault()(Code) Check if this is the default platform. true for the one default platform isHarness public static boolean isHarness(File dir)(Code) Check whether a given directory is really a valid harness. isLabelValid public static boolean isLabelValid(String supposedLabel)(Code) Returns whether the given label (see NbPlatform.getLabel ) is valid. Valid label must be non-null and must not be used by any already defined platform. isPlatformDirectory public static boolean isPlatformDirectory(File destdir)(Code) Check whether a given directory on disk is a valid destdir as per NbPlatform.getDestDir . Parameters:   destdir - a candidate directory true if it can be used as a platform isSupportedPlatform public static boolean isSupportedPlatform(File destdir)(Code) isValid public boolean isValid()(Code) Test whether this platform is valid or not. See NbPlatform.isPlatformDirectory moveJavadocRootDown public void moveJavadocRootDown(int indexToDown) throws IOException(Code) moveJavadocRootUp public void moveJavadocRootUp(int indexToUp) throws IOException(Code) moveSourceRootDown public void moveSourceRootDown(int indexToDown) throws IOException(Code) moveSourceRootUp public void moveSourceRootUp(int indexToUp) throws IOException(Code) removeJavadocRoots public void removeJavadocRoots(URL[] urlsToRemove) throws IOException(Code) Remove given javadoc roots from the current javadoc root list and save the result into the global properties in the userdir (see PropertyUtils.putGlobalProperties ) removePlatform public static void removePlatform(NbPlatform plaf) throws IOException(Code) removePropertyChangeListener public void removePropertyChangeListener(PropertyChangeListener listener)(Code) removeSourceRoots public void removeSourceRoots(URL[] urlsToRemove) throws IOException(Code) Remove given source roots from the current source root list and save the result into the global properties in the userdir (see PropertyUtils.putGlobalProperties ) reset public static void reset()(Code) Reset cached info so unit tests can start from scratch. setDestDir public void setDestDir(File destdir)(Code) setHarnessLocation public void setHarnessLocation(File harness) throws IOException(Code) Set a new location for this platform's harness. setJavadocRoots public void setJavadocRoots(URL[] roots) throws IOException(Code) setSourceRoots public void setSourceRoots(URL[] roots) throws IOException(Code) toString public String toString()(Code) urlsToAntPath static String urlsToAntPath(URL[] urls)(Code) 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)