Template for documenting Java classes

Could anyone suggest a website that provides a template for the correct format for documenting Java classes, and programs?
I have been told there is one on the Java website, but after hours of searching it I could not find the specific page for the template.
Thanks for the help!!!!!

I assume u want to use the javadoc tool:
http://java.sun.com/j2se/javadoc/
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Similar Messages

XJC Tool - For building Java classes from Schema

Hi all,
I am using XJC tool for Building java classes from Schema.
Can we have any other tool for generating java classes from Schema?
Thanks in advance,
typurohit

Solved my own problem and forgot to post the answer: the "xsd:import" is also considered as a targetNamespace, so each xsd:import needs a package specified as well when using oracg. It would be helpful if the Oracle documentation had stated that, but it does not point this out.

How to use junit for a java class in netbeans

hi friends,
im new to java(fresher) and i need step by step creation of junit class for a java class in net beans6.5.so anybody plz explain me in detail.......

Hi venkatakrishna.chaithanya,
With NetBeans :
- hit F1 to get the Help screen;
- select the Search tab;
- enter the word junit;
- in the left pane, select *7 Creating a JUnit Test*;
- read the intructions displayed in the right pane.

Javadoc for oracle java classes

Hi there!
Is there anywhere a Javadoc for all Oracle Java Packages? I've found a Javadoc for oracle.forms.Jdapi, but it would be useful to get a Javadoc for all Oracle classes
thx
Christian

Hi,
some of teh JavDocs are contained in the JDeveloper online help, others are available in the documentation
http://download-uk.oracle.com/docs/cd/B31017_01/web.htm
If you are aftre Forms related Javadocs, the Oracle Forms UI docs are not published
Frank

What is the best practise to provide a text file for a Java class in a OSGi bundle in CQ?

This is probably a very basic question so please bear with me.
What is the best way to provide a .txt file to be read by a Java class in a OSGi bundle in CQ 5.5?
I have been able to read a file called "test.txt" that I put in a structure like this /src/resources/<any-sub-folder>/test.txt from my java class at /src/main/java/com/test/mytest/Test.java using the bundle's getResource and getEntry calls but I was not able to use the context.getDataFile. How is this getDataFile method call to be used?
And what if I want to read the file located in another bundle, is it possible? or can I add the file to some repository and then access it - but I am not clear how to do this.
And I would also like to know what is the best practise if I need to provide a large data set in a flat file to be read by a Java class in CQ5.
Please provide detailed steps or point me to a how to guide or other helpful resources as I am a novice.
Thank you in advance for your time and help.
VS

As you can read in the OSGi Core specification (section 4.5.2), the getDataFile() method is to read/write a file in the bundle's private persistent area. It cannot be used to read files contained in the bundle. The issue Sham mentions refers to a version of Felix which is not used in CQ.
The methods you mentioned (getResource and getEntry) are appropriate for reading files contained in a bundle.
Reading a file from the repository is done using the JCR API. You can see a blueprint for how to do this by looking at the readFile method in http://svn.apache.org/repos/asf/jackrabbit/tags/2.4.0/jackrabbit-jcr-commons/src/main/java /org/apache/jackrabbit/commons/JcrUtils.java. Unfortunately, this method is not currently usable as it was declared incorrectly (should be a static method, but is an instance method).
Regards,
Justin

Creating stubs for a java class which implements ejbobject and ejbHome

Hi,
I am using the weblogic rmic utility to generate WLStub of a class which implements
EJBHome and EJBObject. The stubs are being generated with the name...WLStub261b2l255i2g1h1324e2u702w6fn1t.class
rather than with the name_WLStub as it should be and as the server wants it to
be when I try to bind this object using JNDI.
I appreciate your help.
Thanks,
Kamps

Have you tried the -nomanglednames option as from:
Usage: java weblogic.rmic [options] <classes>...
where options include:
-help Print this help message.
-version Print version information.
-d <dir> Target (top-level) directory for compilation.
-nontransactional Suspends the transaction before making the
RMI call and resumes after
-verbosemethods Instruments proxies to print debug info to
std err.
-descriptor <example> Associates or creates a descriptor for each
remote class.
-nomanglednames Don't mangle the names of the stubs and
skeletons.
kamps wrote:
>
Hi,
I am using the weblogic rmic utility to generate WLStub of a class which implements
EJBHome and EJBObject. The stubs are being generated with the name...WLStub261b2l255i2g1h1324e2u702w6fn1t.class
rather than with the name_WLStub as it should be and as the server wants it to
be when I try to bind this object using JNDI.
I appreciate your help.
Thanks,
Kamps

Any tools for converting java class to xml schema ?

Hi,
Are there any tools out there that can convert my java class to xml schema. How such tools take care of java collections like HashTable, ArrayList etc. in my class structure. I am not interested in writing any configuration files(like jaxb configuration files, jibx binding xml files etc.) for serving this purpose and the can be able to give me xml schema from the java classes. Please suggest ...
I am not sure even JAXB 2.0 allows me to do this without writing any jaxb configuration files or annotations in my java class which is not there in JDK 1.4.2
Thanks & Regards,
Kr.

Hi,
You can convert the EDI file to XML in any of the ways
1) Using third party seeburger adapters
2) Conversion agent
3) Stylus studio.
I think using java code it will be very difficult.
Thnx
Chirag

Configure remote-config for calling java class

Hi...all
i'm newbie, i got trouble for configure remote-config in flex project
how to configure remote-config.xml, if i have java class like below
package org.springframework.flex.samples.secured;
import java.util.Map;
import org.springframework.flex.security.AuthenticationResultUtils;
public class SecurityHelper {
public Map<String, Object> getAuthentication() {
return AuthenticationResultUtils.getAuthenticationResult();
please help me.....i'm newbie and wanna learnin
thanks

Hi,
May be this could be of good help to you
http://livedocs.adobe.com/blazeds/1/blazeds_devguide/
Thanks,
Balaji

Help for using java class in forms 9i

hi
i have been trying to use java class in forms9i but unable to execute ,i have encountered exceptions,for which exception handlers have been declared like ora_java.java_error and exception_thrown but failed to handle run time errors , i have tried all ways from my side.
my java class returns a simple string
i need help on various work arounds
thanks in advance
yash

sir
i have written a simple java class which returns a string hello imported using a java importer in forms 9i
and i call my class in when button press trigger
i have also imported java.lang.Exception for my exception handlers,i have no compile errors,but when i run my forms i get run time error and my exception handlers fail to trap it . ihave no idea how to proceed .
should i use bean area in form and call the class using fbean from custom item rigger if so please explain
can i get sample code example for calling a java class methods from forms.
thanks
yash

Suggest tutorial or article for understanding Java Class Loaders

I want to learn about the Java Class Loaders, from basics to writing custom Class Loaders. Please suggest good material for the same.

[http://www.javalobby.org/java/forums/t18345.html]
[http://java.sun.com/developer/onlineTraining/Security/Fundamentals/magercises/ClassLoader/help.html]
[http://publib.boulder.ibm.com/infocenter/javasdk/v1r4m2/index.jsp?topic=/com.ibm.java.doc.diagnostics.142/html/id1100.html]
[http://onjava.com/pub/a/onjava/2005/01/26/classloading.html]
[http://java.sun.com/developer/technicalArticles/Networking/classloaders/]
[http://www.informit.com/articles/article.aspx?p=1187967]
This should keep you busy.
Usually learning about classloader's is coupled with learning to develop with Java's security features and therefore I think most Java security books dedicate a chapter for it.

Help needed to define a xsd for a java class that has initialization block

public class Employee{
public final static Boss boss1 = new Boss("George","Male");
public final static Boss boss2 = new Boss("Barbara",'Female");
public class Boss{
private String name ;
private String sex;
Boss(String name,String sex){
this.name = name;
this.sex = sex;
I am working on a wsdl first webservices.
Can someone come with an xsd for this two class.I am struggling to come with an xsd becuase of the initialization of boss1 and boss2
Please help.
thx
m

shet wrote:
I am struggling to come with an xsd becuase of the initialization of boss1 and boss2Why do you think that there is a dependecy of initialization to XSD development? Normally, you should only be creating the XSD to represent the class structure, not the runtime final value of instance member.
You will have to write the initilization logic in helper or utility classes.
Edited by: Adhir_Mehta on May 17, 2010 8:16 AM

How to create web service for a Java class in SAP NetWeaver Studio

hi all,
i am using SAP Netweaver Developer Studio.have created a normal java project and i want to create web service for one of the classes in this project. i used the Web Service Creation Wizard to create a web service for this class. but it says there's no methods available for VI. all my methods in this class are public, what should i do?

Hi,
I guess there are other ways. But this is an easy way, if you find the right wizards.
Besides this it is good practise to define interface methods so that session bean implement these interface methods, and thus seperate the interface from the implementation.
In this approach you will need 3 projects:
An enterprise application project (will contain EJB Module)
An EJB Module project (will contain session bean)
A Java project (contains code that implements the session bean methods)
In my previous post I suggested to use a J2EE web mudule project. This was a mistake, it should be EJB module.
But it should be possible to do it in another way. It is up to you.
Good luck, Roelof

How to pass a complex type as input for a Java class in Oracle 11g?

Hi All,
This is my Parent Class..
package ADFapplnPackage.model;
public class ParentClass {
String Name;
int age;
public ParentClass() {
super();
This is my ChildClass :
package ADFapplnPackage.model;
public class ChildClass {
public ChildClass() {
super();
public ParentClass display() {
ParentClass obj=new ParentClass();
obj.age=20;
obj.Name="Sabari";
return obj;
I have exposed both of them as webservices.
When I call the display object in the parent class,
I am getting 'parent' as the response.. I mean that ,only the word 'parent' is at the response. I couldnt find any elements (i mean the age and name) in the output.
if my function 'display' in the child class is like
public String display() {
return "hello";
then it is working fine. I am getting "hello" in the response. Why is the webservice supporting only standard datatypes.. and not Class datatypes.
Kindly help me!!
Thanks ,
Sabarisri. N

Hi,
You can't do that with OLEDB. None of OLEDB providers has such a feature.
Yuancai (Charlie) Ye
Use of free SocketPro package for creating super client and server application,
See 30 well-tested and real OLEDB examples
at http://www.udaparts.com

SAP Template for Documentation

Hello
We are going ahead for <b>EP Portal Content Certfication</b> for some of our development. One of the requirement of this certification is that the related documents should conform to the <b>SAP Templates</b>.
Now does anyone know that from where can I get these SAP templates to create my documents ??
Thanks in advance.

Hi Vishal
try out this link.Probably u will get the documents from here.
https://media.sdn.sap.com/html/submitted_docs/Implementation_Roadmap_EP/Enterprise%20Portal/index.htm
Regards
Rajeev.
Do award points for helpful answers in SDn.

Tools for Comparing Java Class Files

Are there any tools out there that can compare two .class files to see if they are the same ?? Please help.
Janet

In Windows there's the FC command that compares two files to see if they are identical. In Unix there is no doubt a similar command. Or you could write a small bit of Java code that reads the two class files and compares them byte by byte.

Template for documenting Java classes

Similar Messages

Maybe you are looking for