org.xbill.DNS

Class Generator

java.lang.Object

org.xbill.DNS.Generator

public class Generator
extends java.lang.Object

A representation of a $GENERATE statement in a master file.

Author:

Brian Wellington

Field Summary

Fields

Modifier and Type	Field and Description
int	dclass The class of the generated records.
long	end The end of the range.
java.lang.String	namePattern The pattern to use for generating record names.
Name	origin The origin to append to relative names.
java.lang.String	rdataPattern The pattern to use for generating record data.
long	start The start of the range.
long	step The step value of the range.
long	ttl The ttl of the generated records.
int	type The type of the generated records.

Constructor Summary

Constructors

Constructor and Description
Generator(long start, long end, long step, java.lang.String namePattern, int type, int dclass, long ttl, java.lang.String rdataPattern, Name origin) Creates a specification for generating records, as a $GENERATE statement in a master file.

Method Summary

Methods

Modifier and Type	Method and Description
Record[]	expand() Constructs and returns all records in the expansion.
Record	nextRecord() Constructs and returns the next record in the expansion.
static boolean	supportedType(int type) Indicates whether generation is supported for this type.
java.lang.String	toString() Converts the generate specification to a string containing the corresponding $GENERATE statement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

start

public long start

The start of the range.

end

public long end

The end of the range.

step

public long step

The step value of the range.

namePattern

public final java.lang.String namePattern

The pattern to use for generating record names.

type

public final int type

The type of the generated records.

dclass

public final int dclass

The class of the generated records.

ttl

public final long ttl

The ttl of the generated records.

rdataPattern

public final java.lang.String rdataPattern

The pattern to use for generating record data.

origin

public final Name origin

The origin to append to relative names.

Constructor Detail

Generator

public Generator(long start,
         long end,
         long step,
         java.lang.String namePattern,
         int type,
         int dclass,
         long ttl,
         java.lang.String rdataPattern,
         Name origin)

Creates a specification for generating records, as a $GENERATE statement in a master file.

Parameters:

start - The start of the range.

end - The end of the range.

step - The step value of the range.

namePattern - The pattern to use for generating record names.

type - The type of the generated records. The supported types are PTR, CNAME, DNAME, A, AAAA, and NS.

dclass - The class of the generated records.

ttl - The ttl of the generated records.

rdataPattern - The pattern to use for generating record data.

origin - The origin to append to relative names.

Throws:

java.lang.IllegalArgumentException - The range is invalid.

java.lang.IllegalArgumentException - The type does not support generation.

java.lang.IllegalArgumentException - The dclass is not a valid class.

Method Detail

supportedType

public static boolean supportedType(int type)

Indicates whether generation is supported for this type.

Throws:

InvalidTypeException - The type is out of range.

nextRecord

public Record nextRecord()
                  throws java.io.IOException

Constructs and returns the next record in the expansion.

Throws:

java.io.IOException - The name or rdata was invalid after substitutions were performed.

expand

public Record[] expand()
                throws java.io.IOException

Constructs and returns all records in the expansion.

Throws:

java.io.IOException - The name or rdata of a record was invalid after substitutions were performed.

toString

public java.lang.String toString()

Converts the generate specification to a string containing the corresponding $GENERATE statement.

Overrides:

toString in class java.lang.Object